Skip to main content
This guide gets you from zero to a fully running NodeForgeCMS instance on your local machine. By the end you’ll have the backend server, frontend, and admin dashboard all running — ready for you to log in and start building.
1

Check Prerequisites

Before you begin, make sure the following are installed and running on your machine:
  • Node.js 20.x — NodeForgeCMS requires Node 20 or later.
  • MySQL 8.x — The primary data store for all CMS content and configuration.
  • Redis 7 — Used for session caching and performance optimization.
  • pnpm — The package manager used across both the server and admin packages.
Confirm your versions before continuing to avoid setup issues.
2

Clone the Repository and Install Dependencies

Clone the NodeForgeCMS repository, then install dependencies for both the server/ and admin/ packages separately.
Install server dependencies:
Install admin panel dependencies:
3

Configure Environment Variables

Create a .env file in the server/ directory. You can copy the provided example file and fill in your values:
Edit server/.env with your local configuration:
server/.env
Replace your_password and your_secret_key with your own values. The email fields are optional for local development.
4

Initialize the Database

Create the node_forge_cms database in MySQL, then import the bundled SQL schema and seed file:
This creates all required tables and inserts default configuration data, including the initial admin user.
5

Start the Development Server

From the project root, start the Nuxt4 backend and frontend server:
The server will start at http://localhost:3000. You can visit this URL to see the public-facing site frontend.
6

Start the Admin Panel

Open a second terminal and start the admin panel:
The admin dashboard will be available at http://localhost:4000.Log in with the default credentials:
Change the default admin password immediately after your first login. Do not use admin123 in any environment beyond initial local development.
This quickstart uses development mode for both packages. For production deployment — including PM2 process management, production builds, and shared vs. separate domain configurations — see the full Installation Guide.