Installation

How to install dependencies and structure your app.

Prerequisites

Required Tools

Make sure you have these tools installed before proceeding

Package Manager

Choose one of the following:

Node.js

Version 18 or higher required

Git

For version control and cloning the repository

Code Editor

We recommend using one of these editors:

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:

Terminal

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

Terminal

2. Install dependencies

Terminal

3. Set up environment variables

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

4. Start the development server

Terminal

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

5. Seed your Database

Terminal

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