Skip to main content

Prerequisites

  • Node.js 18+
  • pnpm 8+ (corepack enable recommended)
  • A Gemini API key for AI chat features (optional but required for /api/chat)

Step 1 — Clone the repository

If you fork the project, adjust the Git URL accordingly.

Step 2 — Install dependencies

pnpm is the supported package manager.
This command also sets up the TypeScript, ESLint, and Tailwind configurations used throughout the monorepo.

Step 3 — Configure environment variables

Create .env.local in the project root:
Add the variables you need for local development:
Wrap keys in quotes only if they contain special characters. The chat API already strips accidental quotes and whitespace.

Step 4 — Run the development server

Visit http://localhost:3000 to explore the workspace. Hot reloading keeps the UI in sync as you edit files.

Step 5 — Validate the setup

Run the recommended checks before opening a pull request:
The build step runs Next.js static analysis and ensures routes bundle correctly.

Next steps

Tour the platform

Review each dashboard module and identify the areas you want to customize first.

Contribute

Learn the branching, commit, and translation workflows used by the Lab68 team.

Integrate AI

Explore the Gemini-backed endpoint powering the AI tools surface.

Open issues

Pick up community tasks or report bugs directly on GitHub.