浏览代码

doc: fix better doc for api develop, droping dead hint (#10906)

Signed-off-by: yihong0618 <zouzou0208@gmail.com>
tags/0.12.0
yihong 11 个月前
父节点
当前提交
ec9f6220c9
没有帐户链接到提交者的电子邮件
共有 1 个文件被更改,包括 6 次插入9 次删除
  1. 6
    9
      api/README.md

+ 6
- 9
api/README.md 查看文件

@@ -18,12 +18,17 @@
```

2. Copy `.env.example` to `.env`

```cli
cp .env.example .env
```
3. Generate a `SECRET_KEY` in the `.env` file.

bash for Linux
```bash for Linux
sed -i "/^SECRET_KEY=/c\SECRET_KEY=$(openssl rand -base64 42)" .env
```
bash for Mac
```bash for Mac
secret_key=$(openssl rand -base64 42)
sed -i '' "/^SECRET_KEY=/c\\
@@ -41,14 +46,6 @@
poetry install
```

In case of contributors missing to update dependencies for `pyproject.toml`, you can perform the following shell instead.

```bash
poetry shell # activate current environment
poetry add $(cat requirements.txt) # install dependencies of production and update pyproject.toml
poetry add $(cat requirements-dev.txt) --group dev # install dependencies of development and update pyproject.toml
```

6. Run migrate

Before the first launch, migrate the database to the latest version.

正在加载...
取消
保存