Beefboard's image storage api
Development of snapstock is done in typescript. The project
requires node 8.x.x, Node 10 will not pass tests.
It is recommeded to install nvm on your system, so that this project
will automattically use the node version required
npm install to install dependencies
Airbnb tslinting style is applied to snapstock, and is enforced via githooks. Builds will not succeed unless linting rules are conformed to.
Tests are written in jest, and require 100% coverage in order for build to succeed.
npm test to run tests
Running in developer mode is as simple as npm start.
This starts ts-node, which compiles typescript to javascript on
the fly for node.
Building can be completed with npm run build
Deployment is automatic with gitlab-ci. Pushing to master or development
will automatically run tests, build the project and push to the docker repo