Welcome to my solution for this challenge. I will describe below my technical decisions and how to run the application. If you have any additional question, feel free to ask me.
- Fix unit test
- Include Debug config
- Excluding js files from testing and preventing unknown errors
- Increase test coverage
- Clean code
- Typescript (To make the code more organized and easy to navigate)
- Jest and Supertest
- Axios
- TS Node Dev (For development environment)
-
I tried to isolate the responsability of the modules following the SOLID principles as much as possible;
-
I used dependency injection, specificaly in the service layer. This prevents errors and helps, makes the class cohesive and makes testing easier.
-
Middlewares are being used to validate the API input. Due to the time constraint I decided to do it manually, but using a 3rd party library could be an alternative.
-
I've create as much tests as possible. The test coverage could be enhanced on a next version.
- The way to run is basically the same. If you wish to run in a dev environment with Typescript, you can run the command
npm run dev:serveras per package.json file.
- VSCode debugging is available and configured in .vscode folder.
- You may also debug the tests if you want to. You may change the selected folder with the
--testPathPattern=<folder|pattern>property.
You may find the documentation of the API here https://documenter.getpostman.com/view/4694407/UV5f7tbA
Your goal is to extend the functionality of this Node.js service.
Powerball is a popular US lottery game with draws twice a week. For the purposes of this exercise, a Powerball lottery "ticket" includes the date of the draw and one or more "picks". Each "pick" is a set of 5 integers (from 1-69) along with a 6th integer (the Powerball, from 1-26).
For example, a pick for the draw on 2017-11-09 might be:
02 14 19 21 61 25
Your application's API will accept data for a lottery ticket, and respond with whether each pick has won, the prize won per-pick, and the total of all prizes won on the ticket. It is up to you to design and build this API.
The Powerball winning numbers change on each "draw date". In order to determine a win or a loss, your application will have to retrieve the Powerball draw dates and winning numbers from the following public URL:
https://data.ny.gov/resource/d6yy-54nr.json
To calculate the prize, consult the prize matrix image below:
- There is no time limit to this challenge.
- Use your best discretion with the design and requirements, but you can ask questions.
- You must use JavaScript and must extend this code base.
- There is no need for a UI to solve this problem.
- Follow modern JavaScript and Node best practices and conventions to the best of your ability.
- You are free to add packages, tools or improvements to your project as you see fit.
- We expect you to write the kind of feature you would put into production, including tests and documentation as you see fit.
This app requires:
- A Linux or MacOS Environment (Windows Untested)
- Node.js LTS 14+
If you do not have node.js installed:
- Install NVM
- Install Node 14
nvm install 14 - Switch to Node 14
nvm use 14
From the checked-out application folder, run:
npm install
This will install dependencies.
npm start
You should see output like this:
node index.js
App listening on port 3000
You can then hit the default endpoint:
http://localhost:3000/
You should see something like this:
{
"messsage": "Hello World"
}To shutdown the server simply send a ^C.
To run the existing (sample) tests simply use:
npm test
You should see output like this:
Test Suites: 3 passed, 3 total
Tests: 5 passed, 5 total
Snapshots: 0 total
Time: 2.585s
Ran all test suites.Make your changes and then create a zip file to send back to us. Make sure you don't include node_modules in the zip file. Send your solution back to the person who emailed you the original problem.
We encourage you to use your best discretion, but also to ask questions and communicate if you need it.