MAA Website

• 官网首页: maa-website（本仓库） -> https://maa.plus
• 文档站: MAA主仓库/docs -> https://docs.maa.plus

注意：文档站的评论区使用此仓库的 Discussions

Project Overview

Project Components

• apps/web MAA official website, build with React, host path /

Prerequisites

• Node.js 24
• pnpm

Development

1. Set Up the Environment

Choose ONE of the following methods to set up your environment:

Local Clone

Please Install Node.js first, then install dependencies using pnpm in the ROOT directory:

npm install -g pnpm
pnpm install --frozen-lockfile --recursive

Remote Setup (Github Codespaces)

Open this repository in GitHub Codespaces. Once it's ready, the environment will be set up automatically.

2. Run the Development Server

Execute in the ROOT directory:

pnpm dev

• apps/web will be hosted on http://localhost:3000

3. Lint Code

General Overview

1. Prettier (global)

   Prettier is configured at the root of the repository.

   Its role is to enforce consistent code style and formatting across all apps/packages.

2. ESLint (per-app)

   ESLint is configured separately within each app/package.

   Its role is to enforce syntax rules, type checks, and framework-specific best practices (e.g., React rules).

Commands

Execute in ROOT directory:

• Lint check

pnpm lint              # Both (prettier -> eslint)
pnpm lint:format       # Use Prettier for code formatting
pnpm lint:code         # Use ESLint for JS/TS code

• Lint fix

pnpm lintfix           # Both (prettier -> eslint)
pnpm lintfix:format    # Use Prettier for code formatting
pnpm lintfix:code      # Use ESLint for JS/TS code

4. Build the Project

Execute in ROOT directory:

pnpm build

The build artifacts will be generated in ./dist. You can serve them locally with:

python -m http.server -d ./dist --bind 127.0.0.1

or any other ways that you prefer.