ECN>> StarterNodeApi>> 返回
项目作者： jlovo256

项目描述 ：
Starter Node APi
高级语言： JavaScript
项目地址: git://github.com/jlovo256/StarterNodeApi.git
创建时间： 2018-08-25T21:22:25Z
项目社区：https://github.com/jlovo256/StarterNodeApi
开源协议：
下载


StarterNodeApi

StarterNodeApi

Things to Note

  • You need a .env file. Included in the project is TEMPLATE.env, which has all the variables you need. .gitignore is already set to ignore .env files.

Prerequisites

Installing

The easiest way to get started is to clone the repository:

  1. # Get the latest snapshot with https
  2. git clone https://github.com/jtdarkly/StarterNodeApi.git
  3. # or ssh
  4. git clone git@github.com:jtdarkly/StarterNodeApi.git
  6. # Change directory
  7. cd StarterNodeApi
  9. # Install NPM dependencies
  10. npm install

You will need to create an .env file in the project directory.

  1. NODE_ENV=yourvalue
  2. HOST=yourvalue
  3. PORT=yourvalue
  4. PUBLIC_BASE_URL=yourvalue
  6. DB_HOST=yourvalue
  7. DB_PORT=yourvalue

Within app, defaults are set to:

  1. NODE_ENV=development
  2. HOST=http://localhost
  3. PORT=1337
  4. PUBLIC_BASE_URL=http://localhost:1337
  6. DB_HOST=127.0.0.1
  7. DB_PORT=6379

Usage

  2. # Start the API server using node
  3. npm start
  5. # Start in development mode
  6. npm run dev
  8. # Test it*
  9. npm test
  10. # or
  11. npm run test:all
  13. # Just integration test*
  14. npm run test:integration
  16. # Just unit test*
  17. npm run test:unit
  19. # Just system test*
  20. npm run test:system
  • When run, NODE_ENV is always set to ‘test’.

API Information

  • Swagger doc can be found in /src/public or URI host/static/swagger.yaml
  • Swagger UI can be found at URI host/api-docs

Dependencies