GitXplorerGitXplorer
s

nodejs-postgresql-jsonapi-graphql

public
0 stars
0 forks
0 issues

Commits

List of commits on branch develop.
Unverified
71c8858af98383ab4ce3a75809b6bf51b3f5e965

added migrations & seed dirs

committed 8 years ago
Unverified
759d056279b22e9a0394d88fc2e5d079a2e110e0

Merge branch 'feature/programmatic-migrations' into develop

committed 8 years ago
Unverified
919258e96597c16a0bfe8b0f5199261695e5bb5c

restructured for seeds; WIP

committed 8 years ago
Unverified
5096516f0d365c7e54d50eac2b4bb8cc07043800

removed flyway-cli package

committed 8 years ago
Unverified
3e5b95b4eeb4b618f219d18f40f94410949aa0c1

restructured for db migrations with flywaydb-cli

committed 8 years ago
Unverified
b7f2e5f222f3eee3df3ff4797c65d43bc7cf86ad

updated migrations sql

committed 8 years ago

README

The README file for this repository.

(WIP) Nodejs | PostgreSQL | JSONAPI Server

This is a boilerplate API server using Node.js, PostgreSQL, and json:api spec.

Requirements

  • Node.js 6.5+
  • PostgreSQL 9.5+

js-standard-style

Installation

This repo comes with support for Docker using GNU Make targets

Clone this repo:

git remote add origin https://github.com/sgraham785/nodejs-postgresql-jsonapi-graphql.git app

Docker Usage

Build the app and database docker images & containers locally then run them in development mode:

make build-dev

If you already have the images built and want to create the containers & run them in development mode:

make up-dev

To stop and remove the containers (not images):

make down

See make help for more options

Run tests

make test

Configuration

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

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

  • [x] Declarative routes
  • [x] Public vs. Private(JWT) routes
  • [x] Add security best practices
  • [x] Use JSON API specification
  • [x] Use JWT for private route auth
  • [x] Create Postman collection
  • [x] Add mailer
  • [x] Use faker for seeding
  • [x] Utilize swagger documentation
  • [x] Dockerize
  • [x] Add SSL
  • [x] Add health check endpoint
  • [ ] Add tests
  • [x] ES6
  • [ ] Support routes singular and/or plural
  • [x] Generate fake seed data
  • [x] Programmatic Migrations
  • [ ] Fix programmatic seeding
  • [x] Graphql enabled
  • [ ] Add yarn support
  • [ ] Render email html w/ React.js
  • [ ] Add Cloudrail support

Known Issues