Commit e84bab75d94d781f25066d8bed0b542070e2c73e
Committed by
GitHub
GitHub
1 parent
a1a5542a
Update README.md
Showing
1 changed file
with
4 additions
and
35 deletions
back-end/h5-api/README.md
| 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 | #!zh: 鲁班H5的后端接口，由 [Strapi](https://github.com/strapi/strapi/) 强力驱动 |
| 3 | 3 | ||
| 4 | -## Project setup | ||
| 5 | -#!zh: 项目启动 | ||
| 6 | 4 | ||
| 7 | -```bash | ||
| 8 | -yarn | ||
| 9 | 5 | ||
| 10 | -yarn dev | 6 | +## Getting Started(English) |
| 7 | +<a href="https://www.yuque.com/liuyan-ew1qk/oh5d0n/gpfy6g" target="_blank">Read the Getting Started tutorial</a> | ||
| 11 | 8 | ||
| 12 | -# #!en: default database is sqlite3(h5-api/.tmp/data.db) | ||
| 13 | -# #!zh: 默认数据库是 sqlite3，位置在 h5-api/.tmp/data.db | ||
| 14 | -# visit http://locahost:1337/admin | ||
| 15 | -``` | ||
| 16 | - | ||
| 17 | -## Warning | ||
| 18 | -#!zh: 注意事项 | ||
| 19 | - | ||
| 20 | -1. if you dev locally, if the api give you 403 Forbidden, please select all the options in [Roles And Permission] -> [Public] - [Permissions] | ||
| 21 | - | ||
| 22 | -#!zh: 本地开发，如果后端接口报错 403 Forbidden，请 编辑 下图的 [Roles And Permission] -> [Public] - [Permissions] 里面打开接口的访问权限接口 | ||
| 23 | - | ||
| 24 | - | ||
| 25 | - | ||
| 26 | - | ||
| 27 | - | ||
| 28 | -## Features(zh) | ||
| 29 | - - [x] 创建、保存、更新作品 | ||
| 30 | - - [x] 在线预览 | ||
| 31 | - - [x] 二维码预览 | ||
| 32 | - - [x] 表单数据收集 | ||
| 33 | - - [x] 表单数据展示 | ||
| 34 | - | ||
| 35 | -## Features(en) | ||
| 36 | - - [x] create work | ||
| 37 | - - [x] save work | ||
| 38 | - - [x] update work | ||
| 39 | - - [x] Online Preview | ||
| 40 | - - [x] QR Code Preview | ||
| 41 | - - [x] Form Statistics | 9 | +## 快速上手(中文) |
| 10 | +<a href="https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html" target="_blank">请阅读快速上手指南</a> |