Installation

In this part of the documentation, we are going to show you how to install and deploy the NextAdmin Boilerplate.

Before we start the installation process, make sure you have Node.js installed on your machine. You can download it from Node.js (opens in a new tab).

Get the Template

The easiest way to get started is by cloning the repository directly from GitHub.

1. Clone the repository:

   git clone https://github.com/NextAdminHQ/nextjs-admin-dashboard.git
2. Navigate to the project folder:

   cd nextjs-admin-dashboard

Install Dependencies

Once you are inside the project folder, follow these steps to install dependencies and start the development server.

1. Install Dependencies

Choose your preferred package manager to install the required dependencies:

npm install 

If you encounter dependency compatibility issues during installation, you can try using the --legacy-peer-deps flag:

npm install --legacy-peer-deps 

Configure Integrations

Before running the project locally, you'll need to set up the necessary integrations. Follow the guides below to complete the setup:

1. Database Setup
2. Authentication
3. Algolia Search
4. File Uploads

Start Development Server

Once the integrations are configured, you can launch the template on your local server.

npm run dev 

Your application will be live at http://localhost:3000 (opens in a new tab)

Deploying on PaaS

If you are using a GitHub repository, you can easily deploy your project using platforms like Vercel (opens in a new tab) or Netlify (opens in a new tab). They offer excellent free tiers for hosting Next.js applications.

CAUTION: Remember to override the installation command in your deployment settings to include the --legacy-peer-deps flag, if you face dependency compatibility issues.