NovaStack

English

简体中文

English

简体中文

Appearance

NovaStack Project Documentation ​

Welcome to the NovaStack full-stack development framework! This documentation will help you quickly get started and understand how to use this framework to build modern applications.

Requirements ​

Before you begin, please ensure your development environment meets the following requirements:

  • Node.js v16.0.0 or higher
  • PNPM v8.0.0 or higher
  • Git
  • Supported operating systems: Windows, macOS, Linux

Installing Dependencies ​

After cloning the project, you first need to install the project dependencies:

bash
pnpm install

TIP

First-time installation may take a few minutes, depending on your network environment and computer performance.

Environment Configuration ​

The project uses .env files for environment configuration. You can copy the .env.example file and modify it as needed:

bash
cp .env.example .env

Here are some important environment variables:

# Application Configuration
APP_NAME=NovaStack
APP_ENV=development
APP_PORT=3000
APP_URL=http://localhost:3000

# Database Configuration
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=novastack
DB_USERNAME=root
DB_PASSWORD=

# API Configuration
API_PREFIX=/api

Note

Do not commit the .env file containing sensitive information to version control systems.

Database Migration ​

If your project uses a database, you need to run migration commands to set up the database structure:

bash
pnpm run migrate

This will create all necessary tables and initial data.

Starting the Development Server ​

After completing the above steps, you can start the development server:

bash
pnpm run dev

Once the development server is running, you can access the application in your browser at http://localhost:3000.

Development Mode Features ​

  • Hot Module Replacement (HMR)
  • Real-time error notifications
  • Auto-reload
  • Development debugging tools

Common Commands ​

The project provides several useful npm script commands:

  • pnpm run lint - Run ESLint to check code standards
  • pnpm run format - Format code using Prettier
  • pnpm run typecheck - Run TypeScript type checking
  • pnpm run build - Build the application for production
  • pnpm run start - Start the application in production mode
  • pnpm run test - Run unit tests

More Information ​

For more detailed information about the project, please refer to:

  • README.md
  • API Documentation
  • Source code comments