Quickstart

Get LifyGo running locally in under 5 minutes.

Prerequisites

Before you begin, make sure you have the following installed:

Docker
Go 1.22+
Node.js 20+

1. Clone the Repository

git clone https://github.com/lifygo/lifygo.git
cd lifygo

2. Start Infrastructure Services

Start PostgreSQL and Redis using Docker Compose.

docker compose -f infra/docker/docker-compose.yml up -d

3. Configure the API

Navigate to the API application and create your environment file.

cd apps/api
cp .env.example .env

Update the .env file with the following values:

AUTH_PROVIDER=local
JWT_SECRET=at-least-32-characters
DATABASE_URL=postgres://lifygo:lifygo@localhost:5432/lifygo?sslmode=disable
REDIS_URL=redis://localhost:6379
ENCRYPTION_KEY=$(openssl rand -hex 32)

4. Run Database Migrations

migrate \
  -path migrations \
  -database "postgres://lifygo:lifygo@localhost:5432/lifygo?sslmode=disable" \
  up

5. Start the API Server

go run ./cmd/server/main.go

The API will be available at:

http://localhost:8080

6. Start the Dashboard

Open another terminal and run:

cd apps/web
cp .env.local.example .env.local
npm install
npm run dev

The dashboard will be available at:

http://localhost:3000

7. Configure SMTP

Open the dashboard.
Sign in.
Navigate to SMTP Settings.
Add your SMTP credentials.

SMTP passwords are encrypted using AES-256 before being stored.

8. Send Your First Email

Once you’ve generated an API key from the dashboard, test your installation:

curl -X POST http://localhost:8080/send \
  -H "X-API-Key: lfy_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "to":"hello@example.com",
    "subject":"Test",
    "body":"It works."
  }'

If everything is configured correctly, LifyGo will send your first email successfully.

Next Steps

After completing the quickstart, you can explore:

Authentication
Email API
OTP API
Cron Jobs
SMTP Management
Webhooks
SDKs

​Quickstart

​Prerequisites

​1. Clone the Repository

​2. Start Infrastructure Services

​3. Configure the API

​4. Run Database Migrations

​5. Start the API Server

​6. Start the Dashboard

​7. Configure SMTP

​8. Send Your First Email

​Next Steps