跳到主要内容

Installation

This guide covers how to install and run Ever Teams locally for development or production use.

Prerequisites​

RequirementDetails
Node.jsVersion 24.x or higher (download)
YarnVersion 1.13+ (npm install -g yarn)
GitLatest version (download)
OSWindows 10+, macOS 12+, or Ubuntu 20.04+

Clone the Repository​

git clone https://github.com/ever-co/ever-teams.git
cd ever-teams

Install Dependencies​

Ever Teams uses a Yarn-based monorepo with workspaces. Install all dependencies from the root:

yarn install

This will install dependencies for all apps and packages, including:

  • apps/web — Next.js web application
  • apps/mobile — Expo React Native mobile app
  • apps/server-web — Electron web server
  • packages/* — Shared libraries (UI, services, hooks, types, etc.)
提示

If you encounter issues with native modules (e.g., sharp), ensure you have the necessary build tools installed:

  • Windows: Install Visual Studio Build Tools
  • macOS: Install Xcode Command Line Tools (xcode-select --install)
  • Linux: Install build-essential (sudo apt install build-essential)

Run the Web Application​

Development Mode​

Start the web app with hot-reload:

yarn start:web:dev

This runs the Next.js development server on http://localhost:3030.

Production Mode​

Build and start the production server:

yarn build:web && yarn start:web

Development with Package Rebuilds​

If you are working on shared packages alongside the web app:

yarn dev:web

This command builds all shared packages (services, types, constants, ui, hooks, utils) first, then starts the web app in development mode.

Run the Mobile Application​

The mobile app uses Expo and React Native:

cd apps/mobile
yarn install
yarn start

This starts the Expo development server. You can then:

  • Press i to open in iOS Simulator (macOS only)
  • Press a to open in Android Emulator
  • Scan the QR code with the Expo Go app on your physical device

Run the Desktop Application​

The desktop application is based on Electron:

# Build the web app for desktop
yarn build:web:desktop

# Prepare and start the server-web Electron app
yarn dev:server-web

Run the Browser Extension​

The browser extension is built with Plasmo:

cd apps/extensions
yarn install
yarn dev

Load the extension in Chrome:

  1. Navigate to chrome://extensions
  2. Enable Developer mode
  3. Click Load unpacked
  4. Select the apps/extensions/build/chrome-mv3-dev directory

Build Scripts Reference​

ScriptDescription
yarn start:web:devStart web app in dev mode
yarn build:webBuild web app for production
yarn start:webStart built web app
yarn dev:webBuild all packages + start web dev server
yarn build:mobileBuild mobile app
yarn build:extensionsBuild browser extension
yarn build:server-webBuild Electron web server
yarn buildBuild everything (via Turbo)
yarn lintRun linters across all packages
yarn testRun test suite
yarn formatFormat code with Prettier

Verify Your Setup​

After starting the web application, verify everything is working:

  1. Open http://localhost:3030
  2. You should see the Ever Teams login/registration page
  3. Register a new account or sign in with existing credentials
  4. You're ready to start using Ever Teams!

Troubleshooting​

Common Issues​

IssueSolution
ENOSPC: System limit for file watchers reachedIncrease the file watcher limit: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
sharp installation failsInstall platform-specific build tools (see Prerequisites)
Port 3030 already in useKill the existing process or set a different port in .env
EMFILE: too many open filesIncrease file handle limits or set UV_THREADPOOL_SIZE=64

Next Steps​