Crypto Currency Returns ₿

A Flask app that calculates your crypto currency returns based off your initial investment.

Installation

1. Installation and Setup Instructions

   $ pip3 install -r requirements.txt (Python 3)

2. Obtain an API Key for Auth0. Set the keys as an environment variable. Using the following format for macOS and Linux Distributions:

   export KEY=value
   export client_id=AUTH0_CLIENT_ID
   export client_secret=AUTH0_CLIENT_SECRET
   export api_base_url=AUTH0_DOMAIN
   export access_token_url=AUTH0_ACCESS_TOKEN_URL
   export authorize_url=AUTH0_AUTHROIZE_URL
   
   

   and add them with the following format KEY=environ.get("value")

   If you are ever adding your own code to GitHub and choose to use a .env file, make sure it's listed under a .gitignore file. Therefore, it doesn't accidently get published to GitHub!

Usage

To launch the app:

$ python3 CryptoReturns.py

Once the Flask app is running, navigate to the localhost link provided:

* Running on https://127.0.0.1:5000/ (Press CTRL+C to quit)

Live Demo

• Coin Metrics

Special Thanks

• CoinGecko API - Documentation on how to setup CoinGecko's API

• Manolis Christoforou CoinGecko API wrapper - Python3 wrapper around the CoinGecko API (V3)

• Auth0 API - Documentation on how to setup Auth0's API for login purposes.

Learn More

• Flask Starter Guide - A great starter guide on how to learn Flask
• Flask Tutorial - A more in-depth tutorial on Flask
• About .gitignore and config files - A step-by-step guide on how to hide your API keys

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Future Features Currently Working On

• Dockerize this project
• Display realtime data