Get Started

Buy a Plan

Choose a plan that best suits your needs. Click here to buy a plan and unlock all the features admin-boil has to offer.

Run the Install Command

Navigate to your project folder and run the following command in your terminal:

npx admin-boil@latest init

Enter Your Email and API Key

After running the install command, the terminal will ask for**:**

1. Your registered email address.
2. Your API key, which you can find on your profile page.

Enter the details when prompted to proceed.

Copy and Paste Your API Key

Log in to your profile page to copy your API key. Paste the key into the terminal when prompted, then press Enter.

Let the Terminal Work

Once you provide your API key, the terminal will handle the rest. It will download and configure the necessary files to set up your admin dashboard.

Set Up Databases

To enable full functionality, you'll need to configure two databases:

1. Redis Database

   • Go to Upstash and create a Redis database.
   • Copy the generated key and add it to your .env file like this:

     NEXT_PUBLIC_UPSTASH_REDIS_REST_TOKEN=your-upstash-key
     NEXT_PUBLIC_UPSTASH_REDIS_REST_URL=your-upstash-url
     

2. PostgreSQL Database

   • Visit Neon and create a PostgreSQL database.
   • Copy the database key and add it to your .env file:

     DRIZZLE_DATABASE_URL=your-neon-key
     

Run Your App

With everything set up, start your app by running the following command in the terminal:

npm run dev