Quick Start

Get iAm running locally in under 5 minutes.

Prerequisites

Make sure you have Node.js >= 24, Yarn 1.x, and Docker Desktop installed. See the Installation Guide for details.

Steps

1. Clone and install

git clone https://github.com/clarknoah/iAm.git
cd iAm
yarn install

2. Configure environment

cp .env.example .env
cp server/.env.example server/.env
cp client/.env.example client/.env
cp neo4j/.env.example neo4j/.env

Edit the .env files with your local configuration. At minimum, set a Neo4j password and matching JWT secrets. See the Installation Guide for details on each file.

3. Launch everything

yarn launch-all

This starts Neo4j, Redis, the client dev server, and the API server in a tmux session.

4. Open the app

• Client: http://localhost:3330
• GraphQL Playground: http://localhost:3331/graphql
• Neo4j Browser: http://localhost:7474

5. Stop everything

yarn kill-all

What's Next?

• Architecture Overview -- Understand how the system is structured
• Core Concepts -- Learn the domain model for consciousness measurement
• Development Standards -- Review coding conventions before contributing
• Contributing Guide -- Learn how to contribute to the project

Essential Commands

Command	Description
yarn launch-all	Start all services (Neo4j, Redis, client, server)
yarn attach-tmux	Reattach to the tmux session
yarn kill-all	Stop everything
cd client && yarn dev	Start client only
cd server && yarn dev	Start server only
cd server && yarn build:types:all	Regenerate GraphQL types
yarn build	Build everything for production
yarn format	Format code with Prettier