Skip to content

Example of NodeJS API backed by a SQL store and documented using Swagger

License

Notifications You must be signed in to change notification settings

ColdFire87/nodejs-sql-api

Repository files navigation

NodeJS Example API

Based on https://github.com/simonrenoult/nodejs-application-architecture

Travis Codecov

Description

  • backed by SQL store

    • SQLite3 in dev
    • Postgres in prod (not tested) - use env var DATABASE_URL
  • documented using Swagger:

    • Swagger UI available at /api-docs
    • Swagger JSON API spec available at /api-docs.json

Instructions

Start

Server will listen on port 3000 by default (can be overridden with environment variable PORT)

$ yarn start

Test

$ yarn test

Lint

$ yarn run lint

License

MIT License

Copyright (c) 2018 Stefan Tertan.

FOSSA Status

About

Example of NodeJS API backed by a SQL store and documented using Swagger

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •