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許可下。