Installation

Follow these steps to set up your environment and begin using our tools.

Prerequisites

Before you begin, ensure you have:

• Package Manager (Bun, npm, or Yarn)
• Node.js 18+

Step-by-Step Installation

1. Fork and clone the repository

First, fork the repository by visiting The Boring Template and clicking the 'Fork' button.

Then clone your forked repository:

git clone https://github.com/Boring-template/the-boring-template
cd the-boring-template

Alternatively, if you don't want to fork, you can clone directly:

git clone https://github.com/Boring-template/the-boring-template.git
cd the-boring-template

2. Install dependencies

bun install
# or
npm install
# or
yarn install

3. Set up environment variables

Follow the Environment Variables guide to configure your .env.local file.

4. Start the development server

bun dev
# or
npm run dev
# or
yarn dev

Your application should now be running at http://localhost:3000.

5. Seed your Database

bun db:seed
# or
npm run db:seed
# or
yarn run db:seed

Your database should now be seeded with the default data (seed.ts).