Good-Food-Tracker API优质餐饮追踪系统后端开发指南

Good-Food-Tracker API 项目概述

该项目是一个基于 Node.js 和 Express 构建的 后端 Web API,支持 前端 Web 应用 (Vue.js) 和 移动应用 (Kotlin)。项目为用户提供一个便捷的食物记录平台,用户可以 拍照、留下笔记 以及对所访问餐馆进行评分、评论等操作,为日后就餐或订餐提供参考。

项目结构与功能

  • 后端 Web API:Node.js + Express 构建,用于处理餐馆信息和用户交互的数据。
  • 前端 Web 应用:Vue.js 构建,用于在浏览器上与用户互动。
  • 移动应用:Kotlin 构建,提供移动端用户体验。

功能列表

查看 API 的功能及开发进展,请参阅项目文档中的详细章节。该文档包含了现有功能及未来规划。

开发环境设置

  1. 重命名文件:将 .env.example 文件重命名为 .env,并添加您项目所需的配置值。
  2. 依赖安装:运行 npm install 以安装所需依赖。
  3. 数据库配置:创建 MySQL 数据库。
  4. 数据库迁移:运行 db-migrate up 以执行所有数据库迁移。
  5. 开发服务器启动:运行 npm run dev 启动开发服务器。
  6. 访问验证:在浏览器中访问 localhost:3000 检查服务器运行状态。

贡献指南

如有意贡献,请遵循项目的贡献准则,确保协作开发顺畅。

zip
good-food-tracker-api-master.zip 预估大小:76个文件
folder
good-food-tracker-api-master 文件夹
file
app.ts 3KB
file
.env.example 128B
folder
.github 文件夹
file
dependabot.yml 106B
folder
ISSUE_TEMPLATE 文件夹
file
bug_report.md 834B
file
feature_request.md 595B
file
database.json 351B
folder
languages 文件夹
file
english.json 4KB
folder
migrations 文件夹
file
20200925180733-create-refresh-token-table.js 1KB
file
20200910083935-create-review-table.js 1KB
file
20200909063746-crete-city-and-alter-restaurant.js 1KB
folder
sqls 文件夹
file
20200902112256-add-guid-to-user-table-down.sql 171B
file
20200925180733-create-refresh-token-table-up.sql 357B
file
20200905170221-create-user-role-table-up.sql 580B
file
20200909063746-crete-city-and-alter-restaurant-up.sql 498B
file
20201004143530-add-city-and-country-to-user-table-up.sql 221B
file
20200902112256-add-guid-to-user-table-up.sql 248B
file
20200829180451-user-down.sql 18B
file
20200909063746-crete-city-and-alter-restaurant-down.sql 333B
file
20200905160044-add-guid-to-restaurant-table-down.sql 73B
file
20200831070439-restaurant-down.sql 22B
file
20201004143530-add-city-and-country-to-user-table-down.sql 83B
file
20200925180733-create-refresh-token-table-down.sql 25B
file
20200829180451-user-up.sql 644B
file
20201002194557-remove-is-revoked-and-revoked-at-from-refresh-token-down.sql 202B
file
20201002194557-remove-is-revoked-and-revoked-at-from-refresh-token-up.sql 99B
file
20200905170221-create-user-role-table-down.sql 101B
file
20200909075558-add-country-table-down.sql 69B
file
20200910083935-create-review-table-up.sql 1KB
file
20200910083935-create-review-table-down.sql 278B
file
20200905160044-add-guid-to-restaurant-table-up.sql 217B
file
20200831070439-restaurant-up.sql 689B
file
20200909075558-add-country-table-up.sql 5KB
file
20200903065516-add-image-column-to-user-table-up.sql 67B
file
20200903065516-add-image-column-to-user-table-down.sql 35B
file
20201002194557-remove-is-revoked-and-revoked-at-from-refresh-token.js 1KB
file
20200831070439-restaurant.js 1KB
file
20200909075558-add-country-table.js 1KB
file
20200903065516-add-image-column-to-user-table.js 1KB
file
20200829180451-user.js 1KB
file
20200905160044-add-guid-to-restaurant-table.js 1KB
file
20201004143530-add-city-and-country-to-user-table.js 1KB
file
20200902112256-add-guid-to-user-table.js 1KB
file
20200905170221-create-user-role-table.js 1KB
folder
helpers 文件夹
folder
database 文件夹
folder
models 文件夹
file
restaurant.ts 4KB
file
review.ts 9KB
file
country.ts 2KB
file
city.ts 3KB
file
user.ts 5KB
file
db.ts 2KB
file
typedefs.yml 4KB
file
validation.ts 3KB
file
roles.ts 77B
file
utilities.ts 4KB
folder
interfaces 文件夹
file
request.ts 176B
file
types.ts 389B
file
database.ts 152B
file
translation.ts 751B
file
upload.ts 352B
file
globals.ts 700B
file
CONTRIBUTING.md 9KB
file
tsconfig.json 285B
file
LICENSE 1KB
file
README.md 5KB
file
.all-contributorsrc 974B
file
.editorconfig 39KB
file
CODE_OF_CONDUCT.md 3KB
file
.gitignore 2KB
file
server.ts 1KB
folder
routes 文件夹
file
index.ts 4KB
file
restaurant.ts 4KB
file
review.ts 4KB
file
country.ts 3KB
file
city.ts 10KB
file
profile.ts 4KB
file
package-lock.json 95KB
file
package.json 1KB
...
zip 文件大小:94.71KB