charlesonunze / node-challenge

Node.js Backend challenge

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Node Challenge

Take home test for Node.js developers.

The challenge

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. 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, tests, add features, graphql support, etc.

Instructions

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.

Install

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

Start

To enable logs, use the standard NODE_DEBUG flag with the value DEBUG

NODE_DEBUG=DEBUG yarn start

Test

Make sure that you have a modern version of yarn that supports workspaces, then run:

yarn test

For the acceptance test, make sure you create a challenge_test database.

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 😁!

Thought Process

  • I first setup the user expense domain with help from the user details domain, and added some types as well.
  • I went ahead and implemented the user expense business logic, following the same conventions as the user details domain implementation.
  • I moved the capitalize function to be accessible globally because it's a pure function that other domains could use.
  • I now added unit tests for the util functions across domains.
  • Added acceptance tests, updated the dump.sql script, and fixed some errors.

This was fun to work on! It's my first time working on a DDD project and I love it.

About

Node.js Backend challenge


Languages

Language:TypeScript 87.2%Language:JavaScript 8.4%Language:Dockerfile 4.3%