Quick Start
Get Ever Gauzy running in minutes. Choose your preferred method below.
Option 1: Docker Compose (Recommended for Demos)
The fastest way to try Gauzy is using Docker Compose with our pre-built images.
Prerequisites
- Docker Desktop or Docker Engine with Docker Compose v2.20+
Steps
- Clone the repository:
git clone https://github.com/ever-co/ever-gauzy.git
cd ever-gauzy
- Start the demo environment:
docker-compose -f docker-compose.demo.yml up
This starts the minimal configuration: API server, Web UI, and SQLite database.
- Open in your browser:
Navigate to http://localhost:4200
- Log in:
| User | Password | |
|---|---|---|
| Super Admin | admin@ever.co | admin |
| Employee | employee@ever.co | 123456 |
The demo Docker Compose uses pre-built images from the master branch. No local build required!
Docker Compose Variants
| File | Purpose | Infrastructure |
|---|---|---|
docker-compose.demo.yml | Quick demo/exploration | API + Web UI + SQLite |
docker-compose.yml | Minimal production | API + Web UI + PostgreSQL + full infra |
docker-compose.build.yml | Build everything locally | Full platform build (slow!) |
docker-compose.infra.yml | Infrastructure only | PostgreSQL, Redis, OpenSearch, MinIO, etc. |
Full Infrastructure Stack
The production and build Docker Compose files include:
- PostgreSQL — Primary database
- Pgweb — PostgreSQL web client (http://localhost:8081)
- OpenSearch — Search engine
- OpenSearch Dashboards — Search visualization (http://localhost:5601)
- Dejavu — OpenSearch web UI (http://localhost:1358)
- MinIO — S3-compatible object storage
- Jitsu — Data ingestion engine
- Redis — In-memory caching
- Cube — Analytics/BI semantic layer (http://localhost:4000)
- Zipkin — Distributed tracing
Option 2: Manual Setup (Development)
For active development and full control over the environment.
Prerequisites
Steps
- Clone the repository:
git clone https://github.com/ever-co/ever-gauzy.git
cd ever-gauzy
- Install dependencies and bootstrap:
yarn bootstrap
This installs all NPM packages across the monorepo and bootstraps the Lerna/Nx workspace. It may take several minutes on first run.
- Configure environment (optional):
Copy and edit the sample environment file:
cp .env.sample .env
The defaults work for local development with SQLite. See the Configuration guide for customization.
- Start API and UI:
yarn start
This starts both the API server and Angular UI concurrently:
- API: http://localhost:3000/api
- Swagger: http://localhost:3000/swg
- Web UI: http://localhost:4200
- Log in:
| User | Password | |
|---|---|---|
| Super Admin | admin@ever.co | admin |
| Employee | employee@ever.co | 123456 |
On first start, the database is automatically seeded with initial data (users, sample organizations, etc.). You can re-seed at any time with yarn seed or generate extensive fake data with yarn seed:all.
Option 3: Desktop Applications
Download pre-built desktop applications for your operating system.
Available Applications
| Application | Description |
|---|---|
| Ever® Gauzy™ Server | API server + SQLite/PostgreSQL, serves Web UI. Best for small-medium orgs. |
| Ever® Gauzy™ Desktop App | All-in-one: UI + API + SQLite + Timer. Best for personal use or client-server setup. |
| Ever® Gauzy™ Desktop Timer | Time & activity tracking with screenshots. Best for employees/contractors. |
Download
- Official: gauzy.co/downloads
- GitHub Releases: github.com/ever-co/ever-gauzy/releases
Setup
- Download and install for your OS (Windows/macOS/Linux)
- Run the Setup Wizard with default settings
- Log in with
admin@ever.co/admin(Server/Desktop App) oremployee@ever.co/123456(Timer)
If using Gauzy Server, connect Desktop apps to the API at http://127.0.0.1:3000/api.
What's Next?
- Installation Guide — detailed platform-specific instructions
- Configuration — customize database, email, storage, and more
- Demo & Testing — explore the demo environment and test features
- Architecture Overview — understand the platform internals