parthmakadiya12/nest-offer-aggregator

This repo is built using Nodejs and this is an offer aggregator. It can have multiple clients from where the data comes.

Readme Nest Offer Aggregator

This repo contains a small warmup project in nestjs. It tries to mimic the behavior of mydealz. I have created a structure which can scale when we have multiple clients. However this is done in a short amount of time so might have missed some things that we usually keep in mind when doing it for prod.

How to run this ?

• If you are using nvm then use this command to chhose right node version nvm use
• Install the dependencies by running yarn
• After installing you might want to run docker-compose file to start running the database. docker-compose up (or you can use your own database. change it inside app.modules. (i have hardcode the values there better to use env))
• then you can run yarn start:dev
• test it using curl or postman.

Notes:

• keeping the comments as it is.
• external api. I am not creating types for it considering the time limit
• I have not used env variables . it would be nice to have.
• created a docker file that will create mysql db. (can use anything. there is not any design decision made on selecting this db)
• haven't created stories. Usually i do create story and do commits story by story.
• slug I was not sure what to put so just put '' for now.

Features:

• we have post api that will trigger api call from various providers.
• ideally i would choose cron job that will run and update the new offers from 3rd party provider
• I have used Rest Post api because we can play with it.
• have client factory and clients for better scalablity of the app.
• i can still feel the code quality can be improved at some places.
• added unit test coverage as much as possible . (still can add more considering time I have not added more coverage)

curl --location --request POST 'http://localhost:3000/offers/process-offers'