This pull request completes documentation of existing API endpoints and changes the default development database from sqlite to postgresql. Additionally, some unused project files were removed.
Includes the following changes/additions:
LICENSE.md copyright updated to 2017
knexfile updated with postgres configurations.
All app/routes/* API route functions decorated with ApiDocs documentation.
public/* directory and subfolders removed as they were not being used.
To update and view the documentation locally, perform these commands at the root of the project directory:
npm run apidocs - updates the generated documentation
open ./doc/index.html - opens the documentation website in default browser on macOS
Description
This pull request completes documentation of existing API endpoints and changes the default development database from
sqlitetopostgresql. Additionally, some unused project files were removed.Includes the following changes/additions:
LICENSE.mdcopyright updated to 2017knexfileupdated withpostgresconfigurations.app/routes/*API route functions decorated withApiDocsdocumentation.public/*directory and subfolders removed as they were not being used.To update and view the documentation locally, perform these commands at the root of the project directory:
npm run apidocs- updates the generated documentationopen ./doc/index.html- opens the documentation website in default browser on macOS