Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.33 KB

README.md

File metadata and controls

48 lines (31 loc) · 1.33 KB
Raw

CRYPTO PRICE TRACKER (1)

Crypto Price Tracker is an API which allows users to set alerts on certain crypto tokens. It sends email notification to the user when the price of the token hits a certain trigger value.

Install

Fork

Create your own copy of the project on GitHub. You can do this by clicking the Fork button on the top right corner of the landing page of the repository.

Clone

Note: For this you need to install git on your machine

$ git clone https://github.com/<YOUR_GITHUB_USER_NAME>/Crypto-Price-Tracker

where YOUR_GITHUB_USER_NAME is your GitHub handle.

Setup the .ENV file

Add environment variables

DB_PASSWORD: <POSTGRES PASSWORD>

REDIS_PASSWORD: <REDIS PASSWORD>

JWT_SECRET: <JWT SECRET>

EMAIL_ID: <EMAIL ID>
EMAIL_PASSWORD: <PASSWORD>

Note: Directions to generate email password

Run Docker Compose

$ docker-compose up -d --build

Note: For this you need to install docker on your machine

You are up and running on port 8080!

Documentation

Postman docs link: https://documenter.getpostman.com/view/13627665/2s8YzUwgMu