Skip to content

SwyftxBootcampTeam3/bearwatch

Repository files navigation

BearWatch: a crypto price alert notification tool

Backend Requirements

Frontend Requirements

Node v14.17.4 (best to use NVM to manage node version)
Yarn

If you havent used react before. I highly reccomend going through these docs: https://beta.reactjs.org/ Once you have the correct version of node running, run yarn install to install the package dependanices.

Backend Development

Start the backend by running command in root folder:

docker-compose up -d --build

You can now open the browser and interact with the api documentation at: http://localhost:8000/docs

Flower - Celery monitoring tool dashboard can be accessed at: http://localhost:5556

Frontend Development

Enter the frontend directory, install the NPM packages and start the live server using the yarn scripts:

cd frontend
yarn run start

This will launch the app in your default web browser at http://localhost:3000

githubActions