1. Install MySQL
2. Install Node.js
3. Optional: Install Docker
4. Optional: Install Postman
5. Optional: Install cURL

1. Run mysql scripts to create and populate a sample DB (see mysql.sql)

This API is pre-configured to connect to a localhost DB. If you wish to connect to a different DB, update config/db.json as needed.

1. Clone this repo
2. Install modules npm i
3. Run the app node start
4. Test api: http://localhost:3000/healthz

By default this API runs in port 3000.

1. Clone this repo
2. Under config/db.json, if you DB is running locally change host to your localhost hostname. If it's running somewhere else, change it to the corresponding hostname.
3. Build image docker build -t kenzan .
4. Run image docker run --name kenzan_code_challenge -d -p 3000:3000 kenzan
5. Test api: http://localhost:3000/healthz

1. If you have Postman installed, import postman_collection.json (change hostname as needed).
2. If you have cURL installed, open curl-examples.txt and execute API calls examples in your terminal (change hostname as needed).

TODO: Add Swagger

This excersie is based and adapted usgin my very own API Generator (work in progress). Feel free to try it here.