I made this because I don't particularly like copying out project structure from each of my projects, constantly forgetting to steal certain pieces, or bring in more than is necessary. This isn't really something that should be cloned for anything, but rather downloaded and used as a first commit, or even the beginning of a first commit of a project that will host a REST API using Mongoose.
Note: Includes MongoDB queries that require MongoDB 2.6.0 or greater to function.
This is what this project skeleton includes:
- Docs dependency
- Tests dependency
- Linter dependency
- Code coverage dependency
- Debug dependency
- Some tests that make sure that the framework is properly configured.
- An entire logging framework that can pretty easily handle an alerting system.
It currently only includes a only two controllers with a few routes that can be used for testing error handlers, and fetching the app's logs.
The application follows a much more object oriented approach than I originally planned, but in the interest of good documentation, it turned out alright.
The StatusController is currently wired up with Lumina.
The LogController is set up to use MongoDB's aggregation framework to return nicely structured logs for all HTTP requests.
/status- Simple status handler that just returns 200/database- Handler that returns 200 if all database connections are good./error- Handler that responds with a restify error./exception- Handler that raises an exception that's handled by the restify uncaught exception handler./echo- Handler that responds with the body it's given.
logs- Handler that responds with logs organized by HTTP request.
npm run docs
Generates documentation nice and pretty.
Only recurses through the src directory, because most things worthy of documenting should be in there anyways.
npm test
Runs the tests in the tests folder with the application in debug mode.
Comes set up with a few useful tests that can be used to make sure that error handlers are configured.
test runs with the debug flag set, which can be used anywhere in code as needed.
npm run lint
Runs the linter on everything other than the output folders for docs and coverage.
npm run coverage
Runs the tests with the application in debug mode, and outputs the coverage report to a folder called coverage.
coverage runs with the debug flag set, so it uses the same paths as the normal npm test command.
npm run debug
Runs supervisor so that any changes in the application's code causes the application to terminate the relaunch. Runs with the debug flag set.