README.md

Alko Product API

Alko products as an API! A.k.a Alkon tuotetietokanta rajapintana.

Built with:

• Koa API Boilerplate
• Koa
• Koa Better Router
• Koa Better Body
• Cors
• Helmet
• JOI schema-validator
• JSONAPI Serializer
• Babel
• Morgan
• Debug
• ESLint
• Yarn
• ...and many more

Getting started

1. Be sure you have Yarn installed globally.
2. Clone the repo & run yarn from the project root
3. Copy .env.example to .env
4. import product-catalog (you can find the up-to-date-catalog here) with yarn importData path/to/catalog.xls

Available commands

yarn importData

Imports local .xls-file to DB.

yarn start

Runs Babel watch-command & starts server on http://127.0.0.1 on PORT specified in .env -file (defaults to 8080, http://127.0.0.1:8080).

Note! To start debugging (on DEV), start the app on Linux / OSX with DEBUG=alko-product-api yarn start and on Windows with set DEBUG=alko-product-api yarn start

yarn lint

Lints JS-files inside /src directory

yarn build

Transforms ES6-syntax and builds (+minifies) the project to /build directory.