This is a boilerplate API server using Node.js, PostgreSQL, and json:api spec.
- Node.js 6.5+
- PostgreSQL 9.5+
This repo comes with support for Docker using GNU Make targets
git remote add origin https://github.com/sgraham785/nodejs-postgresql-jsonapi-graphql.git app
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
make test
Rename .env.sample
to .env
and add your configuration credentials
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull/merge request to a maintainer :D
in no particular order
- Declarative routes
- Public vs. Private(JWT) routes
- Add security best practices
- Use JSON API specification
- Use JWT for private route auth
- Create Postman collection
- Add mailer
- Use faker for seeding
- Utilize swagger documentation
- Dockerize
- Add SSL
- Add health check endpoint
- Add tests
- ES6
- Support routes singular and/or plural
- Generate fake seed data
- Programmatic Migrations
- Fix programmatic seeding
- Graphql enabled
- Add yarn support
- Render email html w/ React.js
- Add Cloudrail support