Quickstart

Bootstrap the AIGravity/core monorepo, start the local services, and verify the web app and health endpoints.

Prerequisites

Set up your local environment before you bootstrap the monorepo:

Clone the repository and install the workspace dependencies before you start any services.

Clone the repository

Use Git to clone the monorepo and move into it:

git clone git@github.com:AIGravity/core.git
cd core

You should now be in the repository root with the workspace files available.

Install dependencies

Run the repository bootstrap command from the root of the monorepo:

pnpm setup

Use this command to install the workspace dependencies required by the web app, API, and AI service.

Run the full stack from the repository root with Turborepo.

Start the development environment

Start all workspace services together:

pnpm dev

The command starts the web app, API, and AI service. Wait for each process to finish starting before you test the app.

Verify the web app loads

Open the web app in your browser:

http://localhost:3000

The page should load without errors in the browser. If the app does not load, check the terminal output for the web process first.

Verify the health endpoints

Confirm that the API and AI service are responding:

curl -i http://localhost:3001/api/health

Both endpoints should return 200 OK when the services are healthy.

Use these URLs to confirm each part of the stack is running.

Service	URL	Check
Web app	`http://localhost:3000`	Load the page in a browser
API	`http://localhost:3001`	`GET http://localhost:3001/api/health`
AI service	`http://localhost:8001`	`GET http://localhost:8001/health`

If a check fails, review the corresponding terminal output and restart the service if needed.

If pnpm dev or pnpm setup fails because a port is already in use, stop the process that is holding the port and try again.

If the bootstrap step fails, confirm that Node.js, pnpm, Bun, Python 3.11 or later, and uv are installed and available on your PATH.

If GET http://localhost:3001/api/health or GET http://localhost:8001/health times out or returns an error, the service process is not healthy.

If http://localhost:3000 does not open, check the web app process first.

Confirm the web service started successfully in the terminal.
Refresh the browser after the process is healthy.
If the app still fails, restart pnpm dev and watch for the first error in the logs.

Once the local stack is running, keep the terminal open and start working in the area you need.

Review core concepts

Learn how the Gravity stack is organized before you make changes.

Explore features

See which parts of the app and API you can work with next.

Was this page helpful?

Last updated today