徐烜 / bsth-ebus-h5_editor · Commits

Commit 32744e35a4ea81d9e88f9d58390291960e97f58a

Authored by 小小鲁班
Committed by GitHub
1 parent ed4720ea

docs: update API README.md

Inline Side-by-side
Showing 1 changed file with 18 additions and 4 deletions
back-end/h5-api/README.md
  View file @32744e3
1 ## The api for Luban-H5 powered by [Strapi](https://github.com/strapi/strapi/) 1 ## The api for Luban-H5 powered by [Strapi](https://github.com/strapi/strapi/)
  2 +#!zh: 鲁班H5的后端接口，由 [Strapi](https://github.com/strapi/strapi/) 强力驱动
2 3
3 ## Project setup 4 ## Project setup
  5 +#!zh: 项目启动
4 6
5 ```bash 7 ```bash
6 # install strapi globally 8 # install strapi globally
  9 +# #!zh: 全局安装 strapi
7 npm install strapi@beta -g 10 npm install strapi@beta -g
8 11
9 yarn install 12 yarn install
10 13
11 strapi develop 14 strapi develop
12 15
13 -# default database is sqlite3(h5-api/.tmp/data.db) 16 +# #!en: default database is sqlite3(h5-api/.tmp/data.db)
  17 +# #!zh: 默认数据库是 sqlite3，位置在 h5-api/.tmp/data.db
14 # visit http://locahost:1337/admin 18 # visit http://locahost:1337/admin
15 ``` 19 ```
16 20
  21 +## Warning
  22 +#!zh: 注意事项
  23 +
  24 +1. if you dev locally, if the api give you 403 Forbidden, please select all the options in [Roles And Permission] -> [Public] - [Permissions]
  25 +
  26 +#!zh: 本地开发，如果后端接口报错 403 Forbidden，请 编辑 下图的 [Roles And Permission] -> [Public] - [Permissions] 里面打开接口的访问权限接口
  27 +
  28 +![image](https://user-images.githubusercontent.com/12668546/64065999-658d1580-cc47-11e9-9760-e0ad503ec2e7.png)
  29 +
  30 +![image](https://user-images.githubusercontent.com/12668546/64066025-c288cb80-cc47-11e9-9aaa-a93d79313ebe.png)
17 31
18 ## Features(zh) 32 ## Features(zh)
19 - [x] 创建、保存、更新作品 33 - [x] 创建、保存、更新作品
20 - [x] 在线预览 34 - [x] 在线预览
21 - [x] 二维码预览 35 - [x] 二维码预览
22 - - [ ] 表单数据收集  
23 - - [ ] 表单数据展示 36 + - [x] 表单数据收集
  37 + - [x] 表单数据展示
24 38
25 ## Features(en) 39 ## Features(en)
26 - [x] create work 40 - [x] create work
@@ -28,4 +42,4 @@ strapi develop @@ -28,4 +42,4 @@ strapi develop
28 - [x] update work 42 - [x] update work
29 - [x] Online Preview 43 - [x] Online Preview
30 - [x] QR Code Preview 44 - [x] QR Code Preview
31 - - [ ] Form Statistics  
32 \ No newline at end of file 45 \ No newline at end of file
  46 + - [x] Form Statistics