Getting Started

Welcome to RyzeKit 🚀

Get your app up and running by following the steps below.

Prerequisites

Before you can get started, you will need to have the following installed on your machine.

• Node.js (v20 or higher)
• Git
• pnpm
• A code editor (VSCode, VSCodium, WebStorm, etc.)

Set up a new database

This starter kit uses Drizzle (opens in a new tab) as the database ORM. It is currently configured to use PostgreSQL, but you can manually modify it to use MySQL or SQLite instead. For PostgreSQL, we recommend Neon (opens in a new tab) and Zeabur (opens in a new tab).

Create a new PostgreSQL database and have the connection string ready. The connection string should look something like this:

postgresql://user:password@host:port/database

Initialize a new project

Next, go to your terminal. Then, clone the Github repository.

git clone https://github.com/RyzeKit/nextjs-starterkit.git

Navigate into the project directory.

cd nextjs-starterkit

Install the dependencies.

pnpm install

Now, re-initialize Git for your project.

rm -rf .git
git init
git add .
git commit -m "Initial commit"

Create a .env.local file in the root of the project by copying the .env.example file.

cp .env.local.example .env.local

Migrate the database

Open the .env.local file in your code editor and update the DATABASE_URL environment variable with your database connection string from above.

# Database
DATABASE_URL=postgresql://user:password@host:port/database

Migrate your database.

pnpm drizzle-kit push

Now if you check your database, you should see a user_subscriptions table.

Start the development server

Run the following command in your terminal to start the development server.

pnpm dev

Open http://localhost:3000 (opens in a new tab) in your browser to see your app.

🚀 Congratulations, your app is now up and running! Proceed to the next page to continue with setup.