Skip to Content
Setup

Setup

Follow the steps below to run the Orbitus monorepo in your local development environment.

Requirements

  • Node.js: v20 or later
  • pnpm: v9.14.4 (recommended package manager)
  • Git: Latest stable version

Step 1: Clone the Repository

git clone https://github.com/orbitusdev/orbitus.git
cd website

Step 2: Install Dependencies

npm install

This command will install all workspace packages (apps/* and packages/*).

Step 3: Set Up Environment Variables

Copy the .env.example file to .env:

cp .env.example .env

Then, edit the .env file and fill in the required variables:

  • DATABASE_URL: PostgreSQL connection URL
  • Other API keys (optional)

Step 4: Start the Development Server

Main Website

npm run dev

Open http://localhost:3000  in your browser.

Documentation

npm run dev:docs

Open http://localhost:3001  in your browser.

Storybook

npm run dev:storybook

Open http://localhost:6006  in your browser.

Running Tests

Run all tests:

npm test

With watch mode:

npm run test:watch

Build

Production build:

npm run build

This command will build all workspace packages and applications.

Troubleshooting

Port Conflicts

If a port is already in use, you can change it in the dev script of the respective application’s package.json file.

Dependency Issues

If you encounter package resolution errors, first clean the node_modules folders:

npm run clean

Then, reinstall the dependencies:

npm install

Type Errors

To regenerate TypeScript type definitions:

npm run type-check

Quality Assurance

To run performance audits (Lighthouse CI):

npm run perf

To check type coverage:

npm run type-coverage
Last updated on
Workflow Builder