Skip to content

0xO0O0/node-postgres-jsonapi-server

 
 

Repository files navigation

Nodejs PostgreSQL API Server

This is a boilerplate API server using Node.js and PostgreSQL. It has a TODO example and user auth (which needs some work to finish up)

Requirements

Node.js (duh) 6.5.x +

PostrgreSQL 9.4+

Nodemon

js-standard-style

Installation

npm -g install nodemon

npm install

Configuration

Rename .env.sample to .env and add your configuration credentials

Usage

Run database migrations & seeds:

node source/middleware/database/migrate.js

Run in Postman

Maintainers

sgraham785

Contributing

  1. Create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -am 'Add some feature'
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull/merge request to a maintainer :D

Roadmap

in no particular order

  • Decalative routes
  • Public vs. Private(auth) routes
  • Migrations & Seeds
  • Add security best practices
  • Use JSON API specification
  • Implement password encryption
  • Use JWT for private route auth
  • Create Postman collection
  • Add mailer
  • Use faker for seeding
  • Utilize swagger documentation
  • Dockerize
  • Implement SSL
  • Add health checks
  • Add tests
  • Implement Yo Generator

Known Issues

About

Boilerplate API server using Node.js, PostgreSQL, and uses the JSONApi.org Spec.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.7%
  • HTML 1.3%