Skip to content
Projects

ever-co/ever-rec has 35 GitHub stars and 18 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-15 22:13 UTC. Last push 2026-11-12.

How these counts are measured

What you can do

  • Web-based Platform (React/NextJs)
  • Chrome Extension
  • Desktop App (Electron)
  • Screen Capture / Screen Recording

Measured star growth

in 24h
0
in 7 days
Collecting history
in 15 days
Collecting history
in 1 month
Collecting history

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

Ever® Rec™ - Open Screen Capture, Screen Recording, Images & Video Sharing Platform - https://rec.so

Productivity

README.md

Original

Ever Rec Platform

Gitpod Ready-to-Code Gitter Get help on Codementor

💡 What's New

🌟 What is it

Ever® Rec™ - Screen Capture, Screen Recording, Images & Video Sharing Platform.

NOTE: Platform is currently in active development stage / WIP, please use with caution!

Ever® Rec™ is a powerful, all-in-one platform for effortlessly capturing, annotating, and sharing screen, webcam, and microphone recordings. Available as a standalone web app, Chrome extension, or desktop application, it adapts to your workflow, wherever you work.

The desktop version goes even further by converting continuous screenshots into smooth, high-quality videos, making it ideal for creating tutorials, recording gameplay, tracking workflows, and more.

Designed to run discreetly in the background, Ever® Rec™ lets you stay focused on what matters while it handles recording with speed and simplicity.

✨ Platform Features Overview

  • Web-based Platform (React/NextJs)
  • Chrome Extension
  • Desktop App (Electron)
  • Screen Capture / Screen Recording
  • Mic Capture / Webcam Capture
  • Images / Videos Storage, Annotations and Sharing
  • Secure Video Upload: Enables users to directly upload the generated videos to an S3 bucket for secure storage and easy sharing.

✨ Desktop Application Features

  • Continuous Screen Capture: automatically captures high-resolution screenshots at user-defined intervals, ensuring every critical moment is preserved.
  • Video Compilation: converts sequences of screenshots into smooth, high-quality video files with just a few clicks.
  • Customizable Settings:
  • Configure capture intervals to suit your workflow (e.g., every second, every minute).
  • Select video resolutions (e.g., 720p, 1080p) and output formats.
  • Resource Efficiency: Optimized for minimal impact on system performance and resource usage, ensuring smooth operation even during intensive tasks.
  • Intuitive Interface: Offers a clean and user-friendly interface for starting, stopping, and configuring screen capture sessions.
  • Cross-Platform Compatibility: Fully compatible with Windows, macOS, and Linux environments.

📑 Table of Contents

🌼 Screenshots

Show / Hide Screenshots

TODO

🔗 Links

📊 Activity

Prerequisites

Before you begin, ensure you have the following installed:

Technology Stack

Project Structure

Mono-repo

A mono-repo containing three main applications:

ever-rec/
├── apps/
│   ├── api/          # API Server (NestJS)
│   ├── portal/       # Web UI Portal
│   ├── desktop/      # Desktop Application
│   └── extensions/   # Browser Extensions Portal

Desktop App

Usage

  1. Start Recording
  • Launch the application and press the Start Capturing button to begin screen recording.
  • Screenshots will be captured continuously at the configured intervals.
  1. Stop Recording
  • Press the Stop Capturing button to end the recording session.
  • The application will automatically compile the captured screenshots into a video file.
  1. Configure Settings
  • Access the settings menu to adjust the capture interval (e.g., 1 second, 10 seconds).
  • Select the desired video resolution (e.g., 720p, 1080p).
  • Configure S3 bucket details for direct video upload.

Development

Prerequisites

  • Ensure Node.js and npm are installed on your system.
  • Confirm that your development environment supports NX for build processes.

Build Commands

  1. Install dependencies:

    yarn install
    
  2. Build the project:

    yarn run build
    
  3. Create a desktop application build:

    yarn run make
    

Publishing to a Private NPM Registry

Step 1: Configure npm

  1. Set npm to use your private registry:

    npm set registry https://your-private-registry.com
    npm adduser --registry https://your-private-registry.com
    npm set scope=@your-org
    
  2. Provide your credentials (username, password, email).

Step 2: Publish a Package

  1. Publish an individual package:

    nx run lib-name:publish
    
  2. Verify the package appears in your private registry.

Step 3: Publish All Packages (Optional)

  1. Publish all packages or affected libraries:

    yarn run publish:all or yarn run publish:affected:libraries
    
  2. Verify all packages are listed in your private registry.

Platform Getting Started

Development Environment Setup

  1. System Requirements Check
  • Node.js: Version 20.x or higher
# Verify Node.js version
node --version
# Should output v20.x.x or higher
  • PNPM: Latest stable version
# Install PNPM globally
npm install -g pnpm

# Verify PNPM installation
pnpm --version
  1. Clone the Repository
git clone https://github.com/ever-co/ever-rec
cd ever-rec
  1. Install Dependencies
pnpm install

Environment Configuration

API Environment Setup

  1. Configure API Environment
# For development
cp apps/api/.env.sample apps/api/.env.dev

# For production
cp apps/api/.env.sample apps/api/.env.prod
  1. Required API Environment Variables
# Firebase Configuration
FIREBASE_API_KEY=your_api_key
FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
FIREBASE_DATABASE_URL=https://your_project.firebaseio.com
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_STORAGE_BUCKET=your_project.appspot.com
FIREBASE_MESSAGING_SENDER_ID=your_sender_id
FIREBASE_APP_ID=your_app_id
FIREBASE_MEASUREMENT_ID=your_measurement_id

# Firebase Admin Configuration
FIREBASE_ADMIN_PRIVATE_KEY=your_private_key
FIREBASE_ADMIN_CLIENT_EMAIL=your_client_email

# Extension Configuration
EXTENSION_ID=your_extension_id

Portal Environment Setup

  1. Configure Portal Environment
cp apps/portal/.env.sample apps/portal/.env.local
  1. Required Portal Environment Variables
# API Configuration
NEXT_PUBLIC_API_BASE_URL=http://localhost:3000
NEXT_PUBLIC_WEBSITE_URL=http://localhost:4200
NEXT_PUBLIC_STATIC_FILES_URL=your_static_files_url

# Extension Configuration
EXTENSION_ID=your_extension_id

Extensions Environment Setup

  1. Configure Extensions Environment
# For development
cp apps/extensions/.env.sample apps/extensions/.env.dev

# For production
cp apps/extensions/.env.sample apps/extensions/.env.prod
  1. Required Extensions Environment Variables
EXTENSION_ID=your_extension_id

API_BASE_URL=http://localhost:3000
WEBSITE_URL=http://localhost:4200
STATIC_FILES_URL=your_static_files_url

Development Workflow

  1. Start Development Server
pnpm dev
  1. Access Development Environment

Browser Extension Development

Building Extensions

# Development build
pnpm dev:extensions

# Production build
pnpm build:extensions

Installing in Chrome

  1. Access Chrome Extensions

    • Open Chrome
    • Navigate to chrome://extensions
    • Enable "Developer mode" (toggle in top-right)
  2. Load Extension

    • Click "Load unpacked"
    • Navigate to the project directory
    • Select the appropriate build folder:
      • Development: apps/extensions/build/dev
      • Production: apps/extensions/build/prod
  3. Extension Development Notes

    • Check the extension's background page console for logs
    • Use Chrome's developer tools to debug popup and content scripts

Other browsers

Firebase Integration

Ever Rec sends one anonymous usage report a day about the installation as a whole (counts and feature switches only; EVER_STATS_ENABLED=false turns it off): see docs/ever-platform/anonymous-usage-statistics.md.

Firebase Project Configuration

  1. Create Firebase Project

  2. Web App Setup

    • In Firebase Console, click "Add app"
    • Select web platform (</>)
    • Register the app with a nickname
    • Copy configuration to the appropriate .env file

Authentication Setup

Enable Authentication Methods

- In Firebase Console, go to Authentication > Sign-in method
- Enable required providers:
    - Google
    - Email/Password

Database Configuration

  1. Realtime Database Setup
    • Create a new Realtime Database
    • Start in test mode
    • Update security rules using database.rules.json:
      {
          "rules": {
              // Add the database rules here
          }
      }
      

Storage Setup

  1. Configure Storage
    • Enable Firebase Storage
    • Set up security rules using storage.rules
    • Configure CORS if needed

Google OAuth Configuration

  1. Visit https://console.cloud.google.com/apis/credentials
  2. Select your Firebase project
  3. Create OAuth Client ID credentials
  4. Download credentials and configure for all apps:
    • GOOGLE_CLIENT_ID
    • GOOGLE_CLIENT_SECRET
  5. Configure the OAuth consent screen

Sign in with Ever ID (optional)

Ever Rec can offer Continue with Ever ID next to e-mail/password and Google sign-in. Ever ID is the account of the Ever Platform. The API is a standard OpenID Connect relying party, so any OpenID Connect issuer that supports the authorization code flow with PKCE can be configured the same way.

The provider is off by default. While EVER_ID_ISSUER_URL is unset, the button is hidden, every /api/v1/auth/ever-id/* route except config answers 404 provider_disabled, the API makes no request to any issuer, and the existing sign-in methods behave exactly as before.

API configuration

Variable Default Meaning
EVER_ID_ISSUER_URL unset Issuer URL, for example https://idp.example.com. Unset keeps the provider off. EVER_ID_ISSUER is still read as a deprecated alias.
EVER_ID_CLIENT_ID Client ID of the confidential web client registered at the issuer.
EVER_ID_CLIENT_SECRET Its client secret. Provide it from your secret store; it is never sent to a browser or written to a log.
EVER_ID_REDIRECT_URL https://<api host>/api/v1/auth/ever-id/callback, exactly as registered at the issuer.
EVER_ID_ALLOWED_ISSUERS empty Further accepted token issuers, comma-separated (at most three issuers in total).
EVER_ID_PLATFORM_PROJECT_ID empty Optional Ever Platform project ID; adds its audience scope to the sign-in request.
EVER_ID_LINK_MODE explicit Only explicit is supported: an Ever ID is attached to an existing account from Settings, never by e-mail address.
EVER_ID_SIGN_UP_ALLOWED true Whether a new person may create an account (always after a confirmation screen). EVER_ID_JIT_SIGNUP is still read as a deprecated alias.
EVER_ID_BACKCHANNEL_LOGOUT_ENABLED true Accept back-channel logout requests from the issuer.
EVER_ID_LOGOUT_REVOKE_FIREBASE false On a back-channel logout, also revoke every Firebase refresh token of the account (this ends its other sessions too).

WEBSITE_URL must be set (it already is for CORS): the API sends the browser back to the portal there. The portal and the extensions need no new variable; they read GET /api/v1/auth/ever-id/config at runtime, so the button appears or disappears without a rebuild.

An issuer on an Ever host (*.ever.co) is used only by an Ever-operated install (EVER_INSTALL_SOURCE=cloud). A self-hosted install configured with one keeps the provider off and logs one warning, without contacting that host. Any other issuer works as soon as it is configured.

Registering the client at the issuer

  • Application: web, confidential, authorization code flow with PKCE (S256).
  • Redirect URI: https://<api host>/api/v1/auth/ever-id/callback
  • Back-channel logout URI: https://<api host>/api/v1/auth/ever-id/backchannel-logout
  • Post-logout redirect URI (optional): https://<portal host>/auth/login
  • Scopes requested: openid profile email; with an Ever ID issuer also urn:zitadel:iam:user:resourceowner and, when EVER_ID_PLATFORM_PROJECT_ID is set, that project's audience scope.
  • The ID token must carry email and email_verified; sid and auth_time are used when present.

How it behaves

  • Linked Ever ID: signs in to its account, even if its e-mail address changed since it was connected.
  • New person: when no account uses the verified e-mail address, the portal shows Create your Ever Rec account with the name and e-mail address from Ever ID. The account is created only when the person confirms; leaving the screen creates nothing.
  • Existing e-mail address: when an account with that address exists but is not linked, nothing is created, linked or opened. The person signs in the usual way and connects Ever ID in Settings → Profile → Connected sign-in methods. Connecting asks for a fresh Ever ID sign-in (at most five minutes old) and shows both addresses before anything is saved.
  • Disconnecting is refused while Ever ID is the account's only way to sign in.
  • Back-channel logout ends the Rec sessions opened with that Ever ID session (or, for a logout naming only the person, all of their Ever ID sessions); a logout token is accepted once and only within five minutes of being issued. Refreshing such a session keeps it revocable: its refresh token stays a reference that the logout removes.
  • Bound to the browser and the tab: start sets a short-lived HttpOnly cookie (ever_id_flow, SameSite=Lax, limited to the callback path), and the portal tab keeps a random value whose hash it sends with start. A callback without the cookie, or a portal sign-in link opened in another tab or browser, is refused, so a sign-in link handed to someone else signs nobody in.
  • Rate limits: start, callback, exchange, sign-up and connect routes accept 10 requests a minute per client address and API replica. X-Forwarded-For is used only when the request comes from a private or loopback address (a proxy in front of the API), and then only its last entry.
  • Tokens: ID tokens are verified locally against the issuer's published keys. No Ever ID token is stored. Redirects carry one-time codes only, never a token or an e-mail address. The browser extensions open the web app's login page; no OpenID Connect code runs in them.

Outbound connections and data

The only new outbound target is the configured issuer (discovery document, key set and token endpoint), and only while the provider is enabled. When the Gauzy integration (GAUZY_API_URL) is configured, an Ever ID sign-in also presents the verified ID token to that Gauzy API to open the mirrored session, as the other sign-in methods do; a failure there never blocks the sign-in.

Links are stored in the Realtime Database under ever_identities (keyed by a SHA-256 of issuer and subject) with an index under ever_identities_by_uid. Short-lived records (ever_id_pending, ever_id_pending_signup, ever_id_pending_connect, ever_id_handoff, ever_id_sessions, ever_id_logout_jti) are encrypted with a key derived from REC_JWT_SECRET and expire on their own. database.rules.json closes all of these paths to clients.

Production Build

# Build all packages
pnpm build

# Build specific app
pnpm build:api      # Build API server
pnpm build:portal   # Build web portal
pnpm build:extensions  # Build extensions

💌 Contact Us

🔐 Security

Ever Rec Platform follows good security practices, but 100% security cannot be guaranteed in any software! Ever Rec Platform is provided AS IS without any warranty. Use at your own risk! See more details in the LICENSES.md.

In a production setup, all client-side to server-side (backend, APIs) communications should be encrypted using HTTPS/WSS/SSL (REST APIs, GraphQL endpoint, Socket.io WebSockets, etc.).

If you discover any issue regarding security, please disclose the information responsibly by emailing mailto:[email protected] and not by creating a GitHub issue.

🛡️ License

This software is available under the following licenses:

The default Ever® Rec™ Platform license, without a valid Ever® Rec™ Platform Enterprise or Ever® Rec™ Platform Small Business License agreement, is the Ever® Rec™ Platform Community Edition License

We support the open-source community. If you're building awesome non-profit/open-source projects, we're happy to help and will provide (subject to acceptance criteria) Ever Rec Enterprise edition license and free hosting option! Feel free to contact us at mailto:[email protected] to make a request. More details are explained in our Wiki.

Please see LICENSES for more information on licenses

FOSSA Status

™️ Trademarks

Ever® is a registered trademark of Ever Co. LTD. Ever® Rec™, Ever® Demand™, Ever® Gauzy™, Ever® Teams™ and Ever® OpenSaaS™ are all trademarks of Ever Co. LTD.

The trademarks may only be used with the written permission of Ever Co. LTD. and may not be used to promote or otherwise market competitive products or services.

All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

🍺 Contribute

  • Please give us a :star: on Github, it helps!
  • You are more than welcome to submit feature requests in the separate repo
  • Pull requests are always welcome! Please base pull requests against the develop branch and follow the contributing guide.

💪 Thanks to our Contributors

See our contributors list in CONTRIBUTORS.md. You can also view a full list of our contributors tracked by Github.

⭐ Star History

Star History Chart

❤️ Powered By

Powered by Vercel

©️ Copyright

Copyright © 2024-present, Ever Co. LTD. All rights reserved


Enjoy effortless recording with Ever® Rec™! 🎥