Getting Started

NUS Digital Twin is an open-source project by the City Syntax Lab. The NUS Digital Twin source code is hosted on GitHub.

Prerequisites

Node.js: v18.17.1 or v20.3.0, v22.0.0 or higher. (v19 and v21 are not supported.)
yarn: The package manager used in the project, v1.
Git: The source control tool used in the project.
Text editor: We recommend VS Code for working on NUS Digital Twin.

Fork the NUS Digital Twin repository to your GitHub account and get the source code.
```
git clone git@github.com:City-Syntax/nus-digital-twin.git
cd nus-digital-twin
```
Install dependencies
```
yarn install
```
Create a .env file. There are two mandatory environment variables to run the application. See Environment Variables for the full list of environment variables.
.env
```
PUBLIC_CESIUM_TOKEN='YOUR_CESIUM_ION_TOKEN'
PUBLIC_MAPBOX_TOKEN='YOUR_MAPBOX_ACCESS_TOKEN'
```
Start the local development server.
```
yarn dev
```
Congratulations! You are now ready to work on NUS Digital Twin.