MaaAssistantArknights/maa-website

MAA Website

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

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

Project Overview

Project Components

• apps/web: MAA official website, built with React, hosted at /

Prerequisites

• Node.js v24+
• pnpm v11+

Development

1. Set Up the Environment

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

Local Clone

1. Install pnpm. You could:

   • Use the standalone script without Node.js
   • OR Install Node.js and install pnpm via corepack
   • OR Install Node.js and install pnpm via npm
   • OR Use any other method that you prefer.

2. Install dependencies with pnpm:

   pnpm install
   

   No need to worry about the version issues - they are already taken care of in package.json.

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. (Optional) 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 the 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 the 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 method that you prefer.