Quickstart

Start by opening the project repository to begin work right away

Prerequisites

Ensure the following tools are installed on your machine:

• Node.js (v20.15.1 or later)

• Git

Clone the project repository

Run the following commands to clone the project and navigate to its directory:

git clone [e-mail]:ICS26010-group-3/twin-cj.git
cd twin-cj

Install dependencies

To install the necessary dependencies, use one of the following package manager commands:

NPM

npm install

YARN

yarn install  

PNPM

pnpm install  

Configure environment variables

GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.

1. Create an .env file in the root directory

2. Copy the contents from the .env.example file and paste it into the .env file.

3. Update the sensitive values in the .env file, including the API key, database settings, and similar configurations.

Note: Replace your-api-key and your-database-url with the actual values for your environment.

Start the development server

Start the development server with your preferred package manager:

NPM

npm start dev

YARN

yarn dev

PNPM

pnpm dev