Skip to content

swarmnyc/Fulton0

Repository files navigation

Fulton - Generate JSON API Compliant Backends

Build Status Coverage Status A starter node/typescript project that generates JSON API compliant backends from mongorito models in typescript. It provides you with basic crud operations and filtering. Also includes docker scripts for easy setup and development. JSON API docs Mongorito Docker

Install

cd example_project
npm install #only need to install and build on host machine if you want to debug
npm run build
docker-compose -f docker-compose.dev.yml build
docker-compose -f docker-compose.dev.yml up

Documentation

Check out the docs folder of this repo for more in depth documentation. Documentation

Roadmap/Todo

  • Add more detailed error messaging for incorrect requests on autogenerated routes
  • Migrate less than and greater than filters to new syntax (?filter[property][$gt]=value instead of ?greaterThan[property]=value)
  • Make sure documentation is up to date
  • Add tests and examples to the OAuth Module
  • Set up automated builds and testing
  • (In Progress) Add more tests
  • Break out into an NPM package, rather than being a starter project.
  • Update mongorito

Pull requests welcome

About

Autogenerate JSONAPI compliant backends from mongorito models

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors