NuxtPro

English

简体中文

English

简体中文

Appearance

Quick Start ​

Ready to dive into NuxtPro? This guide walks you through setting up a local dev environment and running your first NuxtPro project.

Prerequisites ​

Before you start, make sure you have the following installed:

  • Node.js: v18.20.4 or later (latest LTS recommended)
  • npm: 10.7.0
  • pnpm: recommended package manager for best dependency management

Check your versions:

bash
node -v
npm -v
pnpm -v

If you don’t have pnpm yet, install it globally:

bash
npm install -g pnpm

Clone the project ​

Clone the NuxtPro repository from GitHub. (If you don’t have access to a private repository, you may see a 404.)

bash
git clone https://github.com/PennyJoly/NuxtPro.git

Then enter the project directory:

bash
cd NuxtPro

Install dependencies ​

From the project root, install dependencies with pnpm:

bash
pnpm install

This may take a few minutes depending on your network. pnpm will download and link required packages efficiently.

Configure environment variables ​

The project relies on environment variables, especially for third-party services (database, payment gateways, etc.).

NuxtPro-Admin ​

  1. Find .env.example in the project root.
  2. Copy it and rename to .env.
  3. Edit .env and fill in values for your local environment / API keys.

NuxtPro-Client ​

  1. Find .env.example in the project root.
  2. Copy it and rename to .env.dev.
  3. Edit .env.dev and fill in values for your local environment / API keys.

For details on each variable and how to obtain them, see Environment Variables.

Import the required MySQL schema ​

Go to NuxtPro-Admin/server/migrations/, locate nuxtpro.sql, and import it (e.g. via Navicat) to create the schema and seed sample data.

image

Start the dev server ​

Once everything is ready, run the Nuxt 3 dev server:

bash
pnpm dev

This starts a hot-reload development environment. You should see output like:

NuxtPro frontend

txt
  ?  Local:   http://localhost:3000/
  ?  Network: use --host to expose

or

NuxtPro admin

txt
  ?  Local:   http://localhost:3002/
  ?  Network: use --host to expose

Open your browser and visit http://localhost:3000. If everything is working, you’ll see the NuxtPro frontend.

Or visit http://localhost:3002 to open the NuxtPro admin app.

You’ve successfully run NuxtPro locally. Next, explore the codebase, add features, or continue with the Development Guide.