README.md

maa-website

Monorepo for MAA Web frontend projects

• MAA Website (Production)
• MAA Website (Development)

Build With:

Monorepo Technology:

Deployment Status:

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