Skip to content

Latest commit

 

History

History
173 lines (117 loc) · 4.15 KB

README.md

File metadata and controls

173 lines (117 loc) · 4.15 KB
Raw

Logo

CrpytoWallet Value Tracker

Keep up with the changes and profits from your crypto assets!

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. License
  5. Contact

About The Project

Keep track of your cryptoassets:
Wallet

Portfolio share:
Cheese

Portfolio time-behavior:
Line Graph

This project is half-done and with lots of room to improvement but it serves the basic functionalities I wanted to implement! You will find real-data updates, plotting. Note that I am not a professional and I am just doing it as a hobby, any comment to improve is more than appreciated.

Built With

This project uses mostly:

Getting Started

Data Model

Using mongo documents, three collections related as shown:

Data Model

Prerequisites

The following steps are required before running the project:

  • Installing Node

    sudo apt install nodejs

  • Installing Docker

     sudo apt-get install docker-ce docker-ce-cli containerd.io

Installation

  1. Get a free API Key at https://api.nomics.com

  2. Get a free API Key at https://www.cryptocompare.com/

  3. Clone the repo

    git clone https://github.com/your_username_/Project-Name.git

  4. Install NPM packages

    npm install

  5. Create a .env file with API_NOMICS_KEY, API_CRYPTOCOMPARE_KEY, SESSION_KEY(set your value) and fill the values.

  6. Run the application and it should be running on https://localhost:3000

  docker-compose up -d

Roadmap

Tasks to be done:

  • Improve API calls for efficiency.
  • Edit the entries in the HTML table manually if data can't be fetched.
  • More stats & Graphs.
  • Boostrap, design & responsive.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Alejandro Martínez Otal - Linkedin - [email protected]

Project Link: https://github.com/AlejandroUPC/cryptoWallet