Take home test for Node.js developers.
This challenge has been designed to measure your knowledge of Node.js, Express, Typescript and various technologies, like monorepos, databases and testing. For your exercise, you will be enhancing this API which serves as the backend for the Pleo app. Whenever a user of the app navigates to the expenses view, it calls this API to collect the list of expenses for that user.
Your objective is to write this new route to fetch the list of expenses for a given user. Right now that domain is empty, so you'll have to build everything from scratch- but you can look over at the user domain for inspiration. Please make sure that the endpoint scales adequately and supports paging, sorting and filtering. Additionally, we would also like you to write some tests for your route.
Finally, as a bonus objective, try to improve any aspect of this API. It could be to add more TS types, better security, tests, add features, graphql support, etc.
Fork this repo with your solution. Ideally, we'd like to see your progression through commits, and don't forget to update the README.md to explain your thought process.
Please let us know how long the challenge takes you. We're not looking for how speedy or lengthy you are. It's just really to give us a clearer idea of what you've produced in the time you decided to take. Feel free to go as big or as small as you want.
Make sure that you have a modern version of yarn
that supports workspaces (>= 1.0
), then run:
yarn
You will also need to install Postgres, create a challenge
database and load the sql file dump.sql
:
psql challenge < dump.sql
To enable logs, use the standard NODE_DEBUG
flag with the value DEBUG
NODE_DEBUG=DEBUG yarn start
Make sure that you have a modern version of yarn
that supports workspaces, then run:
yarn test
The command above will run the following test suites sequentially:
Test suite | Run command | Description |
---|---|---|
Unit | yarn test:unit |
Simple unit tests. |
Mid-level | yarn test:mid-level |
Small integration tests that integration of small components together. |
Acceptances | yarn test:acceptance |
Large integration tests, system tests, end-to-end tests. |
Happy hacking ๐!
- setup postgres (dockerized for more flexibility) and ran tests
- created a branch & setup the expense api (inspired by the user api)
- added filter, paging and sorting to the query
- wrote some tests for the route, db and helper functions
- added
fastest-validator
for api query validation - migrated to
typeorm
for scalability & more. - added a query formatter for typeorm for handling more flexible queries on api
- wrote some tests on the query formatter, db and route
- added openapi & swagger for cool documentation
I must say it was fun working on this, at first I was enveloped in the circle of, how will Pleo want to see ... Well, I love the monorepo approach a lot and I tried my best to maintain a good feet, developing the package in isolation ... And I'm seriously thinking of adding some graphql :)