Skip to main content

Getting started

This guide walks you through setting up your local development environment.

Prerequisites​

  • Node.js 18 or later
  • Git
  • Access to the Charlie Mac Azure tenant (request via your line manager)

Installation​

# Clone the repository
git clone https://github.com/charlie-mac/platform.git
cd platform

# Install dependencies
npm install

# Copy environment config
cp .env.example .env.local

Edit .env.local and fill in the values. See the environment variables reference for details.

Start the development server​

npm run dev

The app will be available at http://localhost:3000.

Run the test suite​

npm test          # unit tests
npm run test:e2e  # end-to-end tests (requires running dev server)
warning

Never commit .env.local — it contains secrets. It is already in .gitignore.

Next steps​

Last updated on by Luke Potter