Quick Start

GridBulk is a modern AI development boilerplate built with full-stack capabilities including user authentication, AI features, payments, and an admin panel — helping you ship ideas faster.

Prerequisites

1. Node.js

Node.js is a runtime environment for executing JavaScript code locally. If not installed, macOS users can install it via brew:

brew install node

Or download the LTS version from the Node.js official website.

After installation, verify by checking the version (v20.19.0 or above is recommended):

node --version

2. Git

Git is a version control tool for tracking code history and collaborating.

macOS users can install Xcode (Git is included with Xcode).

Or download from the Git official website.

git --version

3. Package Manager

Used to install dependencies. We recommend pnpm, but you can also use npm, bun, or yarn.

# Install pnpm via npm
npm install -g pnpm
# Check version
pnpm -v

Tip: If you'd like a better terminal experience, try Warp — it supports multiple tabs, themes, command completion, and more.

Get Started (3 Steps)

1. Clone the Project

Download the repository to your local machine. You can replace gridbulk with any folder name.

Don't want to use Git? You can download the ZIP directly:

Download ZIP

git clone https://github.com/lian-yang/gridbulk.git
cd gridbulk

2. Install Dependencies

Choose a package manager and run the install command. Pick one of the following:

pnpm install

3. Set Up Environment Variables

.env stores the variables needed to run the project (e.g., database, third-party service keys). Copy the example file first, then fill in the values following the comments.

cp .env.example .env

Tip: Common variables include DATABASE_URL, OAuth (GitHub/Google) configuration, and payment-related keys. See the Environment Variables documentation for details.

On this page