Skip to main content

Quickstart

This quickstart is based on the current working product implementation in the split repositories:

  • frontend: ../alpha/fe
  • backend: ../alpha/be

The docs portal itself lives in this beta monorepo under apps/docs.

Prerequisites​

  • Node.js 20+
  • npm for the current alpha repos
  • pnpm 11+ for the beta monorepo docs portal
  • Docker Desktop or Docker Engine

Clone the repositories​

GitHub sources:

  • https://github.com/takeshi-su57/lucky-plan-fe
  • https://github.com/takeshi-su57/lucky-plan-be
  • https://github.com/takeshi-su57/luckyplans for the beta docs and infrastructure monorepo

Backend setup​

From ../alpha/be:

npm install
docker compose up -d
Copy-Item .env.sample .env
npx prisma generate
npx prisma migrate dev
npx prisma db seed

Run the API service:

$env:SERVICE="API_SERVICE"; npm run start:dev

Optional worker processes:

$env:SERVICE="COPY_TRADING_SERVICE"; npm run start:dev
$env:SERVICE="LEADERBOARD_SERVICE"; npm run start:dev

Frontend setup​

From ../alpha/fe:

npm install
npm run dev

The frontend uses GraphQL HTTP and WSS environment variables in app/providers.tsx.

Docs portal setup​

From this repo root:

pnpm --filter @luckyplans/docs dev

Verify​

  • frontend should load on http://localhost:3500
  • docs should load on http://localhost:3002
  • backend API should listen on the port configured in ../alpha/be/.env