Skip to content

baneDD/api-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Express API Template

This is a simple Express API template to use for API development. Features:

  • Containerized for use with Docker
  • Nodemon for development to allow easy reloading on change
  • Includes Swagger UI and JSONdoc autogeneration
  • Logging service to a rolling file
  • Request logs
  • Console logging for development mode
  • SQLite as the database for the example, can be changed to different data source as desired
  • VS Code debugging configuration

Building and running the project

  • Run npm install to install all the project dependencies
  • Run start.sh to run the project locally

NOTE: To enable Swagger UI set NODE_ENV to development