Getting Started
Development Setup

Development Setup

Get TimeTiles up and running for development.

Prerequisites

  • Node.js 24+
  • pnpm
  • Docker and Docker Compose

Quick Start

# Clone the repository
git clone <repository-url>
cd timetiles
 
# Install dependencies
pnpm install
 
# Set up git commit template (optional but recommended)
pnpm setup:git
 
# Start PostgreSQL database
make up
 
# Run database migrations
cd apps/web && pnpm payload:migrate
 
# Start development server
pnpm dev

Open http://localhost:3000 (opens in a new tab) to see the application.

Creating Your First Admin User

cd apps/web
pnpm payload create:user

Follow the prompts to create an admin user, then log in at http://localhost:3000/admin (opens in a new tab)

Development Commands

From the project root:

  • pnpm dev - Start development server
  • pnpm build - Build all packages
  • pnpm test - Run tests
  • pnpm lint - Run linting
  • pnpm format - Format code with Prettier

From apps/web:

  • pnpm dev - Start Next.js dev server
  • pnpm payload:generate - Generate TypeScript types
  • pnpm seed - Seed development data
  • pnpm test - Run Vitest tests

Docker Commands

  • make up - Start PostgreSQL
  • make down - Stop services
  • make logs - View logs

Troubleshooting

Port 3000 in use

lsof -ti:3000 | xargs kill -9

Database connection issues

make down && make up

Reset everything

make clean && make up
OverviewCommit Guidelines