Installation

Get Init up and running on your local machine in just a few minutes. This guide will walk you through setting up the development environment and running your first Init application.

Prerequisites

Before you begin, make sure you have the following installed on your system:

Required Tools

Node.js (v18 or higher) - Download Node.js
pnpm (v8 or higher) - Fast, disk space efficient package manager
Git - Version control system

Install pnpm

If you don't have pnpm installed, install it globally:

npm install -g pnpm

Or using the official installer:

curl -fsSL https://get.pnpm.io/install.sh | sh -

Verify Installation

Check that you have the correct versions installed:

node --version  # Should be v18+
pnpm --version  # Should be v8+
git --version

Quick Start

1. Clone the Repository

git clone https://github.com/your-username/init.git
cd init

2. Install Dependencies

Init uses pnpm workspaces to manage the monorepo. Install all dependencies:

pnpm install

This will install dependencies for all packages in the monorepo including:

Next.js web application
Expo mobile application
API package
Database package
UI components

3. Environment Setup

Copy the example environment files:

# Copy environment files
cp apps/nextjs/.env.example apps/nextjs/.env.local
cp packages/db/.env.example packages/db/.env

4. Database Setup

Init uses Supabase for the database. You have two options:

Option A: Use Supabase Cloud (Recommended for beginners)

Create a free account at supabase.com
Create a new project
Copy your project URL and anon key to the environment files

Option B: Run Supabase Locally

Start the local Supabase stack:

pnpm db:start

This will start:

PostgreSQL database
Supabase Studio (database dashboard)
Auth server
Storage server
Edge functions

5. Start Development

Launch the development servers:

pnpm dev

This starts all development servers concurrently:

Next.js web app: http://localhost:3000
Expo mobile app: Follow the Expo CLI instructions
Supabase Studio: http://localhost:54323

What's Next?

Now that Init is running locally, you can:

Explore the web app at http://localhost:3000
Check out the mobile app using the Expo Go app
View the database in Supabase Studio
Read the development guide to understand the workflow

Project Structure Overview

init/
├── apps/
│   ├── nextjs/          # Next.js web application
│   └── expo/            # Expo mobile application
├── packages/
│   ├── api/             # tRPC API routes
│   ├── db/              # Database schema and utilities
│   ├── ui/              # Shared UI components
│   └── mdx/             # Documentation (you're reading this!)
└── package.json         # Root workspace configuration