Skip to content

Onboarding Guide

Jump to bottom
David Zhu edited this page Apr 2, 2025 · 12 revisions

Welcome to the aucc repository! This guide will help you get set up and ready to contribute to the AUCC Project.

Prerequisites

Before getting started, ensure you have the following tools installed on your system:

  • Git: Version control system for managing code changes.
    • You can install it here
  • Node.js: JavaScript runtime required for running the project.
    • We recommend using node version manager like volta or nvm to install your node version.
  • (Recommended) VSCode: This is our code editor of choice, and we have preconfigured some settings for formatting and linting with prettier and eslint.

Setting Up the Project

1. Clone the Repository

git clone https://github.com/UoaWDCC/aucc.git
cd aucc

2. Install node

You can install node using one of the aforementioned version managers, it should infer the correct version v22.14.0 from the project.

volta install node

or

nvm install 22.14.0
nvm use

3. Install pnpm

We are using pnpm as our node package manager

If using Volta:

volta install [email protected]

If using nvm:

npm i -g [email protected]

4. Install Dependencies

This will install the dependencies for the project

pnpm install

Running the Project

To start the development server, run:

pnpm dev

This will launch the application at http://localhost:3000.

Environment variables

You may notice that there is an error along the lines of ❌ Invalid environment variables... when you try to run the app for the first time.

We use environment variables described in .env.example to store sensitive secrets that should not be committed to the codebase. Check out Managing Secrets for more information on how to get these secrets for local development.

Formatting and Linting

If you are using VSCode, install the following extensions:

  • Prettier, we use this extension to format files to ensure that the code format is standardized across the team.
  • ESLint, we use this code linting to ensure developer follow certain coding guidelines.

If you have any questions, feel free to ask in the team chat!

Clone this wiki locally