Skip to content

feat: add description in README.md about how to install node environment #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Echo-minn wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add description in README.md about how to install node environment #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79624dc
feat: add description in README.md about how to install node environment
Echo-minn Apr 7, 2024
0062d97
feat: add .pylintrc
Echo-minn Apr 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .pylintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[MESSAGES CONTROL]
ignore-patterns=README*.md
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div align="center">
<div style="text-align: center">
<img src="docs/_static/image/aoe-logo.svg" width="250"/>

[![PyPI](https://img.shields.io/pypi/v/OpenAOE)](https://pypi.org/project/OpenAOE)
Expand Down Expand Up @@ -97,8 +97,20 @@ git clone https://github.com/internlm/OpenAOE
cd OpenAOE/openaoe/frontend
npm install
npm run build

# If you don't have NodeJS or npm, install it by:
# installs NVM (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# download and install Node.js
nvm install 20
# verifies the right Node.js version is in the environment
node -v # should print `v20.12.1`
# verifies the right NPM version is in the environment
npm -v # should print `10.5.0`
```

> [!TIP]
> Other latest Node.js versions can be found [here](https://nodejs.org/en/download/package-manager).

### **Start**
```shell
Expand Down
14 changes: 13 additions & 1 deletion docs/README_zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div align="center">
<div style="text-align: center">
<img src="_static/image/aoe-logo.svg" width="250"/>

[![PyPI](https://img.shields.io/pypi/v/OpenAOE)](https://pypi.org/project/OpenAOE)
Expand Down Expand Up @@ -93,8 +93,20 @@ git clone https://github.com/internlm/OpenAOE
cd OpenAOE/openaoe/frontend
npm install
npm run build

# 如果你没有安装 Node.js，你可以通过以下方式安装：:
# install NVM (Node 版本管理器)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# 下载并安装 Node.js，可以指定版本
nvm install 20
# 验证 Node.js 版本
node -v # 应该打印 `v20.12.1`
# 验证 NPM 版本
npm -v # 应该打印 `10.5.0`
```

> [!TIP]
> 其他Node.js版本可以查询 [Node.js官网](https://nodejs.org/en/download/package-manager)。

### **运行**
```shell
Expand Down