pickpost/pickpost-platform

以接口为中心的前后端开发协作平台

PickPost 前后端协作平台

如何使用

私有服务器部署

$ npm install
$ npm run build
$ npm start
$ open http://localhost:7001

如何加入开发

项目后端使用 eggjs 框架，数据库 ORM 使用 mongoose ，前端框架使用 ant-design。

本地开发

依赖 MongoDB 数据库服务，开发前，请先启动数据库

$ npm install
$ npm run dev
$ open http://localhost:7001

数据库设计

详见：/doc/schema.md

提交示例：git commit -m 'feat: 接口文档功能'

项目结构概览

.
├── README.md
├── app
│   ├── assets      // 前端代码
│   ├── common
│   ├── controller
│   ├── io
│   ├── middleware
│   ├── model
│   ├── public      // 静态资源
│   ├── router.js   // 前后端路由
│   ├── service
│   └── view
├── config
│   ├── config.default.js
│   ├── config.prod.js
│   └── plugin.js
├── doc
│   └── schema.md
└── ppackage.json

开发规范

项目内置统一的 eslint 规则配置，代码提交使用 commitlint 进行 message 格式校验，提交前会经过 eslint 检查。

联系我们