Challenge Overview
Challenge objectives
-
Clean up the README on the provided source code.
-
Clean up and update the unit testing code.
Tech stack
-
Node.js
Code access
Repo: https://github.com/tc-bluesource/consumer-api
Branch: develop
You will find a link to access the repo on the challenge forum (available after you register).
You will also find a sample .env file attached on the forum. It has sample configurations in order to run the app locally. You may have to modify some of those values or mock some of the endpoints in order to get the app working.
Detailed requirements
Clean up README
The current README.md file was generated automatically.
You need to clean up the README.md file with proper configuration instructions and instructions on how to start the API and how to run the tests.
Clean up/update the unit test code
You need to:
-
Update all dependencies to the latest version.
-
Replace deprecated dependencies (if needed) with newer ones or alternatives if there are no newer versions.
-
Remove all unnecessary code related to unit testing (if any).
-
Make sure we have as much coverage on unit testing as possible and we have both positive and negative tests.
-
You need to cover all cases where supported (eg 200/400/401/403/404 etc)
-
Reformat the code to follow https://standardjs.com/
-
Make sure we can generate a coverage report