Getting Started

Get EOS Hub running locally in under five minutes.

Prerequisites

Before you begin, make sure you have the following installed:

• Node.js 20 or later
• PostgreSQL 15 or later (or a managed PostgreSQL instance)
• npm, pnpm, or yarn
• Git

Quick Start

1. Clone the Repository

git clone https://github.com/your-org/eos-hub.git
cd eos-hub

2. Install Dependencies

npm install

3. Configure Environment Variables

Copy the example environment file and fill in your values:

cp .env.example .env

At minimum, configure these variables:

# Database
DATABASE_URL="postgresql://user:password@localhost:5432/eos_hub"

# NextAuth
NEXTAUTH_SECRET="your-random-secret-string"
NEXTAUTH_URL="http://localhost:3000"

# Google OAuth (optional for development)
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"

TIP

Generate a secure NEXTAUTH_SECRET with:

openssl rand -base64 32

4. Set Up the Database

Run Prisma migrations to create all tables, then seed with sample data:

npx prisma migrate dev
npx prisma db seed

The seed script creates a demo organization with sample users, teams, Rocks, Scorecard data, and a V/TO.

5. Start the Development Server

npm run dev

Open http://localhost:3000 in your browser. You should see the EOS Hub login page.

6. Sign In

Use the seeded demo credentials:

Role	Email	Password
Super Admin	admin@example.com	password
Team Owner	owner@example.com	password
Member	member@example.com	password

WARNING

These credentials are for development only. Change all passwords before deploying to production.

What to Explore First

After signing in, here is a recommended path through the application:

1. Dashboard -- See the team overview with KPI cards, scorecard trends, and rock progress.
2. Scorecard -- Review weekly measurables and their goals.
3. Rocks -- Check out quarterly priorities and their milestones.
4. L10 Meeting -- Create and run a Level 10 meeting to experience all seven segments.
5. V/TO -- Explore the Vision/Traction Organizer.

Next Steps

• Installation -- Detailed installation guide with all options
• Configuration -- Full environment variable reference
• Organizations & Teams -- Understand the data model
• Roles & Permissions -- Learn about access control