quick-start.md

Quick Start Development Guide

1 .Prerequisites

Ensure you have one of the following programs installed on your machine:

• docker
• node
• deno
• bun

2. Environment

Ensure you have your .env file configured, refer to the .env.example for reference:

3. Database

Ensure you have a postgres database instance running to ensure migrations are ran.

If you have docker installed, you can spin up a database with the following command:

docker compose -f docker-compose.yaml up --build -d

4. Running The App

To get up and running with this template you can run one of the following commands:

Unix Commands:

If you are using npm:

npm install && npx drizzle-kit migrate && npm run dev

If you are using pnpm:

pnpm install  && pnpm exec drizzle-kit migrate && pnpm dev

If you are using deno:

deno install && deno run -A npm:drizzle-kit migrate && deno task dev

If you are using bun:

bun install && bunx drizzle-kit migrate && bun run dev

If you are using docker:

docker compose -f docker-compose.yaml up --build -d

Note For Docker: You will still have to install dependencies and run drizzle-kit migrate with your package manager after.

PowerShell Commands:

If you are using npm:

npm install; if ($?) { npx drizzle-kit migrate }; if ($?) { npm run dev }

If you are using pnpm:

pnpm install; if ($?) { pnpm exec drizzle-kit migrate }; if ($?) { pnpm dev }

If you are using deno:

deno install; if ($?) { deno run -A npm:drizzle-kit migrate }; if ($?) { deno task dev }

If you are using bun:

bun install; if ($?) { bunx drizzle-kit migrate }; if ($?) { bun run dev }

If you are using docker:

docker compose -f docker-compose.yaml up --build -d

Note For Docker: You will still have to install dependencies and run drizzle-kit migrate with your package manager after.