Onboarding

The place to start.

Getting Started

Cloning the Repository

You'll need to have git installed. You can check this by running:

git --version

To clone this project:

HTTP:

git clone https://github.com/UoaWDCC/uabc-web.git

SSH:

git clone git@github.com:UoaWDCC/uabc-web.git

Installing Node.js and PNPM

It is recommended to use Volta or NVM to manage your Node version. You can install it here:

• Volta
• NVM

To install the pinned version of Node.js, we use a .nvmrc file and package.json to keep track of it. Run the following commands to install the version of Node:

NVM:

nvm install
nvm use

Volta:

volta install node

To install the pinned engine versions:

corepack enable

Running the Development Server

Ensure you have the correct secrets set.

pnpm dev

Or to run specific applications:

# Run only the frontend
pnpm dev --filter=frontend

# Run only the backend
pnpm dev --filter=backend

The development servers will be running at:

• Frontend: http://localhost:3001

• Backend: http://localhost:3000