Skip to main content

Installation

This guide will help you set up your local development environment for the Collab Digital Twins Platform.

Prerequisites​

Before you begin, ensure you have the following installed:

  • Node.js (v18 or higher) — Download here
  • Yarn or npm — Package manager for dependencies
  • Git (optional, required for contributing) — Download here

Verify your installations:

node --version
yarn --version  # or: npm --version
git --version

Clone the Repository​

git clone https://github.com/collabdt/core.git
cd core

Install Dependencies​

Using Yarn (recommended):

yarn install

Or using npm:

npm install

Environment Setup​

Create a .env file in the project root:

cp .env.example .env

Update the environment variables as needed for your local setup.

Start the Development Server​

yarn dev

Or with npm:

npm run dev

The application should now be running at http://localhost:3000 (or your configured port).

Verify Installation​

Open your browser and navigate to http://localhost:3000. You should see the CDT interface.

Troubleshooting: If you encounter issues, check our GitHub Issues or reach out via our contact form.