BrokeAz-Trading-React

BrokeAz-Trading-Dashboard

An awesome Trading Dashboard to help you keep up to date with the market!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

[]

This dashboard is a great addition to your trading arsenal!

With a click of a button it will provide daily market informations including:

• the Latest News
• Most Active Stocks
• Daily Gainers/Losers
• Trending Stocks on Fintwits
• Much More!

Using multiple API calls, we're able to webscrape Twitter, Reddit and Stocktwits to keep you up-to-date with what everyone else is saying!

(back to top)

Built With

• React.js
• Express.js
• Node.js
• Python3
• Javascript
• Bootstrap
• PostGreSQL

(back to top)

Getting Started

Download the Repository to your local desktop if you'd like to run the project for yourself!

If you'd like to contribute then Fork the project to your page!

Prerequisites

Ensure you have the latest version of Node.js

npm install npm@latest -g

You'll also need your own API keys for the following:

• Twitter
• Reddit
• Alphavantage
• Fidelity
• Financial Modelling Prep
• Stock Market Data API

Place the keys in the .env file within the Backend Server source folder

Installation

1. Clone the repo

   git clone https://github.com/tranfh/BrokeAz-Trading-React.git

2. Install NPM packages

   npm install

(back to top)

Roadmap

• News
• Insider Info
• Foreign Exchange Rates
• Daily Gainers/Losers
• Fintwit Trendings
• Futures (A page that lists all futures and commodities pricing)
• Crypto (A page that will list all the major cryptocurrencies)
• Charts (Interactive Chart for a specified stock)
• Stock Finanical Details (Provide more insight on a company)
• Login/Registration (database required)
• Database (Start logging and storing collected data from trending fintwits to provide a longer scope)
• Watchlist

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

Frank Tran - Linkedin - frank.tran@live.ca

Project Link - client: BrokeAz-Trading-React

Project Link - server: BrokeAz-Trading-React

(back to top)

Acknowledgments

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)