Getting Started

This guide will help you get Solo Kit up and running on your local development environment.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js 18 or later
• pnpm (recommended) or npm
• Git

Installation

1. Clone the repository

   git clone <your-repository-url>
   cd solo-kit

2. Install dependencies

   pnpm install

3. Set up environment variables

   cp .env.example .env

4. Initialize the database

   pnpm db:push

5. Start the development server

   pnpm dev

Your application will be available at http://localhost:3000.

Development Commands

Here are the most commonly used commands during development:

Core Development

• pnpm dev - Start web development server
• pnpm dev:mobile - Start mobile development server
• pnpm dev:all - Start both web and mobile servers

Database Operations

• pnpm db:push - Push schema changes to database
• pnpm db:studio - Open Drizzle Studio for database management
• pnpm db:seed - Seed the database with sample data

Code Quality

• pnpm lint - Run ESLint on all packages
• pnpm type-check - Run TypeScript type checking
• pnpm test - Run the test suite

Project Structure

├── apps/
│   ├── web/          # Next.js web application
│   └── mobile/       # Expo mobile application
├── packages/
│   ├── ui/           # Shared UI components
│   ├── utils/        # Utility functions
│   └── database/     # Database schema and operations
└── docs/             # Documentation files

What's Next?

Now that you have Solo Kit running locally, explore these topics:

• Architecture Overview
• Feature Flags
• Development Guidelines
• Deployment Guide