Implements a CRUD (create-read-update-delete) API of personal financial transactions. Includes the minimum features in order to represent a realistic production-grade backend.
The features are the following (implementation in parentheis):
- RESTful HTTP interface (
express,body-parser,swagger) - Authentication (
express-jwt,jsonwebtoken,bcrypt) - Authorization (custom code)
- Input validation (
swaggerize-express) - Persistent storage (Postgres with
pg-promise) - Logging (
log) - Uncaught error handling (custom code)
- Integration testing (
mocha,unexpected,istanbul) - Static analysis, "linting" (
eslint,eslint-config-airbnb-base) - Deployment abstraction (Docker container)
- Configuration (custom code)
- Continuous integration setup (TO BE IMPLEMENTED)
- Deployment pipeline (TO BE IMPLEMENTED)
- Documentation (
swagger)
Run integration tests using the following terminal commands. Starts an isolated instance of database and services in a pair of docker containers, runs linting, testing, coverage analysis and shuts all down again afterwards.
docker-compose build
docker-compose up -d postgres
docker-compose run backend sh /app/test/run-tests.sh
docker-compose down
The API is documented in /config/swagger.json. For a fancy HTML rendering you can run the Swagger UI docker image as follows:
docker run -p 9090:8080 -e "SWAGGER_JSON=/minimal-backend/config/swagger.json" -v /local/path/to/repo/minimal-backend:/minimal-backend swaggerapi/swagger-ui
Or simply copy/paste the content of swagger.json to the online Swagger Editor (http://editor.swagger.io). These tools are not included in the Node.js dependencies of the repo for simplicity.