bb41709ce8
- Updated links in CONTRIBUTING.md and README.md to point to the correct Chinese documentation paths. - Removed outdated files including the English and Chinese versions of the branching strategy, contributing guide, and test plan documents. - Cleaned up references to non-existent documentation in the project structure to streamline the contributor experience.
74 lines
893 B
Markdown
74 lines
893 B
Markdown
# 🖥️ Develop
|
|
|
|
## IDE Setup
|
|
|
|
- Editor: [Cursor](https://www.cursor.com/), etc. Any VS Code compatible editor.
|
|
- Linter: [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
- Formatter: [Biome](https://marketplace.visualstudio.com/items?itemName=biomejs.biome)
|
|
|
|
## Project Setup
|
|
|
|
### Install
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
### Development
|
|
|
|
### Setup Node.js
|
|
|
|
Download and install [Node.js v22.x.x](https://nodejs.org/en/download)
|
|
|
|
### Setup Yarn
|
|
|
|
```bash
|
|
corepack enable
|
|
corepack prepare yarn@4.9.1 --activate
|
|
```
|
|
|
|
### Install Dependencies
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
### ENV
|
|
|
|
```bash
|
|
copy .env.example .env
|
|
```
|
|
|
|
### Start
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
|
|
### Debug
|
|
|
|
```bash
|
|
yarn debug
|
|
```
|
|
|
|
Then input chrome://inspect in browser
|
|
|
|
### Test
|
|
|
|
```bash
|
|
yarn test
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
# For windows
|
|
$ yarn build:win
|
|
|
|
# For macOS
|
|
$ yarn build:mac
|
|
|
|
# For Linux
|
|
$ yarn build:linux
|
|
```
|