Git Product home page Git Product logo

paper-trade's Introduction

paper-trade

paper-trade is an interactive React.js web application that allow users to add/remove stocks to/from a watchlist and view stock prices. It is intended for beginner investors to learn about stocks and track their stock trades.

How to Run

  1. Clone the repo into your personal space:
git clone https://github.com/bri-davis/paper-trade.git
cd paper-trade
  1. Install the following Python packages for backend usage:
pip3 install boto3
pip3 install botocore
pip3 install flask
pip3 install flask-cors
pip3 install yfinance
  1. Create an AWS account, then create a DynamoDB table and name it 'paper-trade'.

  2. In the src/backend/ folder, create .aws/credentials and enter your AWS ID and Access Key

[default]
aws_access_key_id = ...
aws_secret_access_key = ... 
  1. In the src/backend/ directory, you can run the Python Flask backend using:
flask run
  1. Install the following Node packages for frontend usage:
npm -i react-bootstrap
npm -i react-router-dom
  1. In the project directory, you can run the frontend using:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

Tech Stack

MIT License

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

Future Considerations

  • Using IEX Cloud API over yfinance
  • Switching current schema to be entirely hosted on AWS using EC2
  • More personalized user interaction with email subcription-based lists

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

paper-trade's People

Contributors

bri-davis avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.