> For the complete documentation index, see [llms.txt](https://se-group-3.gitbook.io/se-group-3-project-workflow/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://se-group-3.gitbook.io/se-group-3-project-workflow/getting-started/quickstart.md).

# Quickstart

Start by opening the project repository to begin work right away

<figure><img src="https://169348336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKOxpdip4vm4BcZaZBkGb%2Fuploads%2FpIQJzGpiibIFjJIFb8wX%2Fimage.png?alt=media&amp;token=c6eccb21-bd04-493f-98dc-ffbfc37f2728" alt=""><figcaption></figcaption></figure>

### Prerequisites

Ensure the following tools are installed on your machine:

* [**Node.js**](https://nodejs.org/en) (v20.15.1 or later)
* [**Git**](https://git-scm.com/)

### Clone the project repository

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

```
git clone git@github.com: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.

{% hint style="info" %}
**Note**: Replace `your-api-key` and `your-database-url` with the actual values for your environment.
{% endhint %}

### Start the development server

Start the development server with your preferred package manager:

#### NPM

```
npm start dev
```

#### YARN

```
yarn dev
```

#### PNPM

```
pnpm dev
```