Prerequisites

• Node.js >= 20.17.0
• pnpm >= 9.13.0
• Docker & Docker Compose (for containerized development)

Getting Started

Local Development

1. Install dependencies:

pnpm i
pnpm papi

2. Start the development servers:

# Start, web and API services and chopsticks
pnpm dev:all

Go to http://localhost:3000 to access the UI.

Docker Development Environment

The project includes a Docker setup for consistent development environments:

# Start all services
docker compose up --build

# Stop services
docker compose down

Chopsticks needs to be run separately, after running the docker compose up command, run the following command from the root directory to start Chopsticks:

# Install all dependencies if not already installed
pnpm i

# Start Chopsticks
pnpm start-chopsticks

Go to http://localhost:3000 to access the UI.

Lint check

To lint the codebase, run the following command:

pnpm lint

This will check for code quality and style issues across the entire monorepo.

Unit tests

To run the tests, use the following command:

pnpm test

Configuration and Environment Variables

See docs/config.md for more details.

Acknowledgements

Check out the NOTICE.md file for more details.