This is a simple API built to satisfy the requirements stated here on the fetch rewards Receipt Processor Challenge.
This API was built using Node JS with express and Typescript. API entries are validated with class-validator, and there are unit tests performed with jest.
The application is deployable via a docker container. You will need Docker installed on your machine to launch this application.
Before you begin, ensure that port 3000 is available on your machine.
In order to build a docker image and run the corresponding container, run the following docker-compose command: docker-compose -f docker-compose.yml up --build -d. This will also trigger all unit tests to be run to prevent the edition of erroneous code.
You can view the container on port 3000 of the machine.
In order to close down your container run docker-compose down
While this application is not intended for production, there are a few additions I would make for a production application, including:
- Adding a ES Lint and Prettier configuration
- Creating production-specific and dev-specific docker images to enable hot-module-reloading
- Adding a DB layer that persists the data (as mentioned in the API specs, data does not need to persist for this project)