Getting Started
This section walks you through everything you need to set up Ever Teams for local development or production use. Pick the path that matches your goal:
| Goal | Guide |
|---|---|
| Run locally for development | Installation → Configuration |
| Deploy with Docker quickly | Docker Quick Start |
| Deploy to a cloud platform | Deployment Guide |
Prerequisites
Before you begin, make sure you have the following installed:
| Tool | Minimum Version | Purpose |
|---|---|---|
| Node.js | >= 24.x | JavaScript runtime |
| Yarn | >= 1.13.0 | Package manager |
| Git | Latest | Version control |
| Docker | >= 20.10 | Containerization (optional, for Docker deployment) |
| Docker Compose | >= 2.20 | Multi-container orchestration (optional) |
Quick Start (3 Steps)
# 1. Clone the repository
git clone https://github.com/ever-co/ever-teams.git
cd ever-teams
# 2. Install dependencies
yarn install
# 3. Start the web app in development mode
yarn start:web:dev
Open http://localhost:3030 in your browser.
к сведению
By default, the web frontend connects to the production Ever Gauzy API at https://api.ever.team. To use a self-hosted backend, see the Configuration guide.
What's Next?
- Installation — Detailed installation instructions for all platforms.
- Configuration — Environment variables, API endpoints, OAuth, and more.
- Architecture Overview — Understand how the codebase is organized.