انتقل إلى المحتوى الرئيسي

Tutorial: Getting Started Step by Step

A comprehensive walkthrough to set up Ever Gauzy from scratch.

Prerequisites​

  • Node.js 20+
  • Yarn 1.x (Classic)
  • PostgreSQL 14+ (or SQLite for quick start)
  • Git

Step 1: Clone the Repository​

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

Step 2: Install Dependencies​

yarn install

This installs all dependencies for the entire monorepo (API, webapp, desktop apps, and all packages).

Step 3: Configure Environment​

Copy the sample environment file:

cp .env.sample .env

Edit .env with your settings:

# Database (SQLite for quick start)
DB_TYPE=sqlite
DB_NAME=gauzy.sqlite3

# JWT Secrets (generate unique values)
JWT_SECRET=change-this-to-a-random-string
JWT_REFRESH_SECRET=change-this-too

# Server URLs
API_BASE_URL=http://localhost:3000
CLIENT_BASE_URL=http://localhost:4200

Step 4: Start the API Server​

yarn start:api

Wait for the message: Listening at http://localhost:3000

The first startup will:

  • Create the database schema
  • Run seed data (demo organization, admin user)
  • Start the REST and GraphQL APIs

Step 5: Start the Web App​

In a new terminal:

yarn start

Open http://localhost:4200 in your browser.

Step 6: Log In​

Use the default admin credentials:

FieldValue
Emailadmin@ever.co
Passwordadmin

Step 7: Explore​

After login, you'll see the dashboard. Explore:

  1. Dashboard — overview widgets
  2. Tasks — task management
  3. Time Tracking — start tracking time
  4. Employees — manage team members
  5. Projects — create projects
  6. Settings — configure your organization

Next Steps​