From all the mandatory, secondary and bonus features detailed in the problem description, just one was not included in this solution due to lack of time: Handle multiple currency pair at the same time.
If this bot was to be run in production, the following actions should be performed:
- Add more tests.
- Comment code.
- Enhance Docker configs (see more on this in the "Run using Docker" section).
- Enhance error handling: There are several operations that should be handled in a better way. eg number parsing and db operations.
- Enhance typing: There are some missing types that could be added, some function result types in the main index file for example.
Docker and Docker Compose have to be available in order to run the project.
In both ticker-exercise and database folders there is a file called .env.example. Please copy their contents into a file called .env in their respective folders. The one in ticker-exercise needs to be set an Uphold application api key and secret in order for it to work.
From the ticker-exercise folder, run:
npm install && npm run test
From the root folder, run:
docker-compose up
Notes:
- Note that in order to make your life easier and be able to run the database and the node container with this only command, the node container is sleeping for 60 seconds before starting to ensure the database is configured correctly (Docker compose's depends_on is not enough in this case). In a more realistic scenario this would not be done this way.
- If a rebuild of the Docker images and recreation of containers is needed, run
docker-compose up --build --force-recreateinstead.
It is possible to run this project out of Docker but the database has to be set up manually. In this case, Node 14 is needed.
After manually creating the db and updating the .env to match your db user's credentials, run:
npm install
npm run build
npm run migrate
npm start
Find the Postgres db connection information in any of the .env files mentioned above (host will be the IP of your Docker host), and connect to it. Query to get all the alerts:
select * from alerts;