Skip to content

neezzzy/fin-dashboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Financial Dashboard

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

This is an open-source project to gather financial information in one place.

Here's why I created it:

  • Your time should be focused on fast and easy to access information
  • You shouldn't be doing a lot of coding to show information from API call
  • You should implement DRY principles to the rest of your life 😄

Built With

(back to top)

Getting Started

Prerequisites

You will need to install the requirements first.

  • pip install
      cd to the directory where requirements.txt is located.
      activate your virtualenv.
      run: pip install -r requirements.txt in your shell.

Installation

  1. Get a free API Key at [https://finnhub.io)
  2. Clone the repo
    git clone https://github.com/neezzzy/fin-dashboard.git
  3. Install requirements
    pip install
  4. Enter your API in config.py
    token = 'ENTER YOUR API';

(back to top)

Usage

Type Stock Symbol and select the options.

(back to top)

Roadmap

  • Add Real Time data
  • Add Charts Screen
  • Multi-language Support
    • Russian

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Ruslan Nizamov - [github) - https://github.com/neezzzy Project Link: https://github.com/neezzzy/fin-dashboard.git

(back to top)

Acknowledgments

(back to top)