The Stonks

The Stonks is an investment practice site that was inspired by popular investing site RobinHood. Our site can be viewed here: https://the-stonks-app.herokuapp.com/

Helpful Docs

1. Feature List
2. DB Schema
3. User Stories

Getting Started

1. Clone this repo

   • https://github.com/MatthewSatt/Stonks_Project_w19.git

2. Install Backend dependencies inside the python-project-starter directory

   • pipenv install

3. Install Frontend dependencies inside the react-app directory

   • npm install

4. Create a .env file base on the .env.example given in the root directory BEWARE the API keys needed are from Finnhub-python and Rapid-API

5. Setup your username and database based on what you setup in your .env inside POSTGRES and in your own API keys

6. Migrate and Seed models into the DB

   • pipenv run flask db upgrade
   • pipenv run flask seed all

7. You can start the front end from the react-app directory by:

   • npm start

8. You can start the backend from the python-project-starter by:

   • pipenv run flask run

9. You can use the Demo user to log in or create an account of your own.

Live

Features

Logged in users can:

• Add/Edit/Delete Thier Watchlists
• Add/ Watchlists
• View the Detail of all stocks within the site

Logged out users can:

• View the Splash page

1. Watch List - Full CRUD

• get/view created list
• create list
• update created list names and elements
• delete created list or elements

2. Portfolio - Full CRUD

• get/view portfolio
• add/buy stocks in portfolio
• delete/sell stocks in portfolio
• update the company name with an alias name (ie: "Tesla - TSLA" ---> "Elon - TSLA")

3. Account Profile

• get/view profile page

4. Specific Stock Detail

• get/view stock details

5. Search Stocks

• get specific stock details by searching by company name or ticker

Technologies Used