express api es6 starter

用Express.js建造API的入门申请

附带：

• ES6功能/模块
• ES7异步/等待
• 书架Orm和Knex迁移
• PostgreSQL（默认）支持MySQL和SQLITE
• 使用Swagger-UI-Dist和Swagger-JSDOC的API文档
• Docker支持开发和生产
• 代码覆盖的Eslint
• 使用JOI请求验证
• 使用漂亮的代码格式
• 使用dotenv的配置管理
• 使用Winston登录
• 使用Sentry报告错误报告
• 使用摩卡咖啡，超级和柴的测试
• VS代码内置调试器支持

---

先决条件

• node.js
• 纱
• NPM
• PostgreSQL / mysql / sqlite

设置

克隆存储库，安装依赖项并立即开始。

 $ git clone --depth=1 [email protected]:mesaugat/express-api-es6-starter.git <application-name>
$ cd <application-name>
$ rm -rf .git
$ yarn   # or npm install

制作.env.example作为.env的副本，然后更新您的应用程序详细信息和数据库凭据。现在，运行迁移并播种数据库。

 $ yarn migrate
$ yarn seed

最后，启动应用程序。

 $ yarn start:dev (For development)
$ NODE_ENV=production yarn start (For production)

导航到http：// localhost：8848/api-docs/以验证安装。

创造新的迁移和种子

这些是创建新迁移和相应种子文件的命令。

 $ yarn make:migration <name>
$ yarn make:seeder <name>

例子，

 $ yarn make:migration create_tags_table
$ yarn make:seeder 02_insert_tags

使用Docker

使用Docker-Compose

使用Docker-Compose快速带有带有预配置的Postgres数据库容器的堆栈。数据是短暂的，当堆栈取出时，容器将消失。

Docker的特定配置在.env.docker中

• 0.0.0.0 AS $APP_HOST将在Docker网络接口上公开应用程序
• 预配置的Postgres设置 - 可以更新以指向另一个Postgres主机

提出堆栈，

 $ docker-compose up

导航到http：// localhost：8848/api-docs/tourify应用程序正在从docker运行。

放下堆栈，

 $ docker-compose down

多阶段码头工具构建

有多个用于不同阶段的构建目标。这些图像可用于在不同的基于容器的云基础架构（例如Kubernetes，AWS ECS，Fargate，Fargate，GCP Cloud运行等）中部署或运行​​作业。

1. 构建生产图像。

   $ docker build --target=prod -t express-api-es6-starter:prod .

2. 构建开发图像。

   $ docker build --target=dev -t express-api-es6-starter:dev .

3. 构建运行迁移和/或回滚的图像。

    # Docker image that runs migration and seeds.
    $ docker build --target=migrate -t express-api-es6-starter:migrate .
   
    # Docker image that rollbacks migrations.
    $ docker build --target=migrate-rollback -t express-api-es6-starter:migrate-rollback .

一旦构建了图像 - 您需要做的就是运行它们提供.env文件。像这样：

$ docker run -v " /path/to/your/.env:/app/.env " mesaugat/express-api-es6-starter:migrate

使用mySQL代替postgresql

首先安装MySQL驱动程序。

 $ yarn add mysql

在您的.env文件中更新这些行。

 - DB_CLIENT='pg'
+ DB_CLIENT='mysql'

- DB_PORT='5432'
+ DB_PORT='3306'

如果您愿意，可以删除PG驱动程序。

 $ yarn remove pg

就是这样，您已经准备好滚动了。

测试

要运行测试，您需要创建一个单独的测试数据库。不要忘记更新您的.env文件以包括测试数据库的连接。

 $ NODE_ENV=test yarn migrate
$ yarn test

运行覆盖范围的测试。

 $ yarn test:coverage

为什么8848？

因为世界上最高点是8848米。

贡献

有关贡献和功能请求，请先创建一个问题。

执照

Express-Api-ES6-Starter在MIT许可下。