Skip to content

MaaAssistantArknights/maa-website

Repository files navigation

maa-website

本仓库已迁移至 MAA 主仓库,请勿在此仓库提交 Commits 和 Pull Request

请勿 Archive 此仓库,文档的评论区仍然使用此仓库的 Discussions

Monorepo for MAA Web frontend projects

Build With:

Node.JS React

Monorepo Technology:

Turborepo Yarn Workspace

Deployment Status:

GitHub Workflow Status (main) GitHub Workflow Status (dev)

Projects

  • apps/web MAA official website, build with React, host path /
  • apps/doc MAA documantation, build with VuePress, host path /doc
  • packages/eslint-config-maa MAA eslint shared configuration
  • packages/maa-react-app MAA react app shared components
  • packages/maa-tsconfig MAA typescript shared configuration

Local Development

Requirements:

  • NodeJS ^16.15.0
  • Yarn ^1.22.19

Resolve dependencies with yarn in root directory

yarn

Start a development server

  • apps/web will be hosted on http://localhost:3000
  • apps/doc will be hosted on http://localhost:3001/doc
yarn dev            # Home and Doc:zh-CN
yarn dev:home       # Home ONLY
yarn dev:doc:cn     # Doc:zh-CN ONLY
yarn dev:doc:en     # Doc:en ONLY

Lint code

yarn lint           # All
yarn lint:js        # Use ESLint for JS/TS code
yarn lint:prettier  # Use Prettier for code formatting

Lint fix

yarn lintfix

Build release

yarn build          # This will run lint first