Running the Project

With dependencies installed, database configured, and environment variables set, you're ready to run the project!

Run the development server

To run all the applications in the monorepo, run the following command from the project root:

pnpm dev

This command starts all applications in the monorepo simultaneously using Turborepo:

• Web app on http://localhost:3000 - the main application that you will be using most of the time
• Dev tools on http://localhost:3010 - the dev tools that you will be using to debug your application (e.g. environment variables, emails, etc.)

Accessing the Application

1. Open Your Browser

Navigate to the web application at http://localhost:3000. You should see the landing page of your application.

Seeding the database

If you have not already done so, you can seed data using the command:

pnpm run seed

This command output will print out some credentials you can use to sign in. Use one of these credentials to jump straight to the dashboard and start using the application.

2. Create Your First Account

To test the sign up flow, click on the "Sign Up" button and create an account with the following credentials:

• Email: any@example.com
• Password: YourSecurePassword123!

What happens:

1. Account is created in the database
2. Default personal account is created
3. You're redirected to the dashboard

We require email confirmation to access the dashboard, so you will need to either:

1. Mailpit: Check the Mailpit (email testing service that we use to test emails) inbox at http://localhost:8025 for the verification email (this needs you to start the Docker compose file)
2. Terminal Logs: Check the terminal logs for the verification token, as we log every email to the terminal if you don't have Mailpit running

3. Explore the Dashboard

After signing in, you'll land on your personal dashboard at http://localhost:3000/dashboard.

Useful Development Commands

Type Checking

Check for TypeScript errors across the entire monorepo:

pnpm typecheck

Output:

Tasks:    15 successful, 15 total
Cached:   0 successful, 0 total
Time:     12.4s

Run this regularly to catch type errors early.

Linting

Check for code quality issues using ESLint:

pnpm lint:fix

Code Formatting

Auto-format all files with Prettier for a standard, consistent codebase:

pnpm format:fix

To execute all of them at once, run:

pnpm healthcheck

Database Commands

# Push schema changes to database (development)
pnpm --filter "@kit/database" drizzle:migrate
# Generate migration files (production)
pnpm --filter "@kit/database" drizzle:generate
# Open Drizzle Studio (database GUI)
pnpm --filter "@kit/database" drizzle:studio
# Run seeds (add test data)
pnpm seed

Development Workflow

Recommended Daily Workflow

We recommend pulling the latest changes from the upstream repository before starting development to avoid conflicts. The more regularly you pull the latest changes, the less likely you are to have conflicts, and less painful they are going to be to resolve. You can do this by running the following command:

Pull latest changes:

git pull upstream main  # If using upstream

After pulling the latest changes, you should run the following commands to ensure your project is up to date:

Install any new dependencies:

pnpm install

If you encounter conflicts in the pnpm-lock.yaml file, you should accept either of the two changes (avoid manual edits as it's a waste of time), then run:

pnpm install

Your lock file will now reflect both your changes and the updates from the upstream repository.

Quick Reference

Most Used Commands

Below are the most used commands you'll need to know to work with the project.

# Start development
pnpm dev
# Starting Local Docker services (DB + Mailpit)
pnpm run compose:dev:up
# Taking down Local Docker services (DB + Mailpit)
pnpm run compose:dev:down
# Resetting the development database
pnpm run db:reset
# Type checking
pnpm typecheck
# Lint and format
pnpm lint:fix
pnpm format:fix
# Starting Stripe webhooks
pnpm run stripe:listen
# Pull latest changes
git pull upstream main  # If using upstream

Resetting the development database

If you're using the provided Docker compose file, by default, it stores data into a local volume. This is useful for development purposes, but sometimes you may want to start fresh (example, you want to revert some changes you made to the database).

To reset the database, you can run the following command:

pnpm run db:reset

This will reset the database to the initial state.

Key URLs

Here are the key URLs you'll need to know:

• App: http://localhost:3000
• Sign Up: http://localhost:3000/auth/sign-up
• Sign In: http://localhost:3000/auth/sign-in
• Dashboard: http://localhost:3000/dashboard
• Drizzle Studio: https://local.drizzle.studio (after running pnpm --filter "@kit/database" drizzle:studio)
• Mailpit: http://localhost:8025

Congratulations! Your development environment is ready. 🎉

Next: Project Structure →