Installation

Create your starter project with the NateUI CLI, then install its packages and run the app locally.

Before you start

You need:

• Node.js 20.9.0 or later. Run node -v to check your version.
• npm, pnpm or yarn.
• A purchase that includes the template you want to use.

The commands below run the CLI through npx, so you do not need to install it separately.

Steps

1. 1

   Sign in

   Open your terminal and run:

   npmpnpmyarn

   npx nateui@latest login

   Enter the email address you used for your purchase. The CLI emails you a 6-digit code; enter that code when prompted.

   If you are asked to choose a template, select it from your dashboard before continuing.

2. 2

   Create your starter project

   Each template has its own flag:

   Template	Flag
   CRM	--crm
   Project Management	--project-management
   Sales & Inventory	--sales-inventory
   AI Chat	--ai-chat

   Run the following command from the folder where you want to create your project. This example creates a CRM starter in a new folder named my-app:

   npmpnpmyarn

   npx nateui@latest init-template --crm my-app

   Replace --crm with your template's flag and my-app with your preferred project folder name. The target folder must be new or empty.

3. 3

   Install the packages

   Enter the project folder. If you chose a different name, use that instead of my-app:

   cd my-app

   Install the packages:

   npmpnpmyarn

   npm install

   For this command and the next, select the tab for the package manager you use: npm, pnpm or yarn.

4. 4

   Start the app

   Start the development server:

   npmpnpmyarn

   npm run dev

   When Next.js is ready, open http://localhost:3000 in your browser. If it uses another port, open the URL shown in your terminal.