layback is a command-line tool for validating API documentation written in Swagger format against its backend implementation. This tool is inspired by Dredd, the API validation tool of API blueprint.

# Running from the root of the project
bash ./scripts/docker_boot.sh

This project started out to create another tool to make sure our software works which in turn lets us get some sleep at night. In the spirit of being able to sleep we try to uphold the following standards.

All code is written test first. No exceptions. Whenever production code is touched a failing test need to be in place.

For versioning we apply Semver's versioning scheme.

To ensure coding style is equal among the whole team codesniffers are run on every commit via a pre-commit hook. Codesniffers used are jsrc and eslint

To make it easier for yourself update your editor so codeing style issues are highlighted immediately.

As of now documentation is written. We will see how that evolves over time.

To be sure that the code is in the shape where we want it to be we use codeclimate and coveralls. These apps will report any issues there may be.

Git is used for version control. On top on that we have a workflow.

Updates are developed according to the Git flow

Every update is reviewed by a peer through a pull request.