LogoBoring Template

Installation

How to install dependencies and structure your app.

This guide will walk you through the process of setting up The Boring Template on your local machine.

Prerequisites

Required Tools

Before you begin the installation process, ensure you have the following tools installed:

Package Manager

Choose one of the following: Bun (recommended), npm, or Yarn

Node.js

Version 18 or higher required

Git

For version control and cloning the repository

Code Editor

We recommend VS Code or WebStorm

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
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:

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

2. Install dependencies

Choose your preferred package manager to install the dependencies:

Terminal
bun install
# or
npm install
# or
yarn install

3. Set up environment variables

Important

You must configure your environment variables properly for the application to work.

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

4. Start the development server

Once you've set up your environment variables, you can start the development server:

Terminal
bun dev
# or
npm run dev
# or
yarn dev

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

5. Seed your Database

To populate your database with initial data:

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

This will seed your database with the default roles and data defined in the seed.ts file.

Next Steps

Environment Setup

Configure your environment variables and services

Project Structure

Learn about the project file organization

Authentication

Set up and configure user authentication

Introduction

This is the documentation for The Boring Template, a modern, full-featured Next.js 15 template for building SaaS applications.

Environment Setup

Configure environment variables and set up essential services for your application.

On this page