Getting Started

Hey there! Welcome to boilergen

In this guide, you'll find all the necessary steps to set up your environment and start building with the fast boilergen setup. After completing this, you can go here to find out how to get the necessary api keys!

1. Clone the Repository

git clone https://github.com/boilergen-org/boilergen-js.git [project-name]
cd [project-name]
npm install

2. Rename the .env.sample File

After cloning the repository and installing the dependencies, you need to rename the .env.sample file to .env. This file contains environment all the variables needed for your project.

mv .env.sample .env

Great, you are done with the Getting Started guide! Your .env file should look like this:

# Rename this file to .env

# Database
DATABASE_URL=""

# Next-Auth
# Enter your own or generate using https://auth-secret-gen.vercel.app/
AUTH_SECRET=""

# OAuth (Google & Github)
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

# Nodemailer (remove if you are using resend

# email
EMAIL=
# password
PASS= 

# Resend email (remove if you are using nodemailer)
RESEND_API_KEY= 

Now, proceed to the API Keys page to find out how to get the necessary API keys.