Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 3.95 KB

README.md

File metadata and controls

83 lines (62 loc) · 3.95 KB
Raw

Purrfolio 💸

Afford the life your cat deserves. 😺

Purrfolio is a stock trading website. Purrfolio allows users to buy and sell stocks and to watch stocks. Purrfolio was created by Dylan, Charles, and Emily Check it out here.

Technologies Used

HTML CSS JavaScript React Redux Python Flask

Index

Features

  • 💸 Create your portfolio
  • 💸 Buy and sell stocks
  • 💸 Search for stocks and view trend data
  • 💸 Create a watchlist to keep an eye on your favorite stocks!

User Stories

Users 👥

Sign Up

  • As a new user, I should be able to sign up for an account with valid information.

Log In

  • As an existing user, I should be able to login with my account information.

Portfolio 💵

View Portfolio

  • As a user after logging in, I should be able to view my portfolio.

Create Portfolio

  • As a user with no funds I should be able to add funds which will create my portfolio.

Update Portfolio

  • As a user, I should be able to add funds to my portfolio.

Delete Stock

  • As a user with a portfolio that has stocks in it, I should have the option to sell my stocks.

Stock Details 💰

View Stock Details

  • As a user, I should be able to access a stock's detail page that shows a graph with the stock's price evaluation over time, the stocks current position and changes.

Purchase Stock

  • As a user, I should be able to purchase stocks from the stock's detail page and see if I already own stocks of this company.

Update Amount of Shares Purchased

  • As a user, when purchasing stocks I should be able to update the total amount of shares I would like to purchase.

Watchlists ⭐

View Watchlists

  • As a user, I should be able to view my watchlists.

Add to Watchlist

  • As a user, I should be able to add stocks to my watchlist.

Delete From Watchlist

  • As a user, I should be able to delete stocks from my watchlist.

Search 🔍

Search Stock By Name

  • As a user, I should be able to search for stocks by company name.

View Search Results

  • As a user, I should be able to view the results of the search and click on the name of the company to see the stock details page.

Transactions 💸

View Transaction History

  • As a user, I should be able to see my transaction history of all stocks bought and sold.

Schema

Database Schema

Installing Locally

  1. Clone this repository: https://github.com/dylan-mcdougall/python-group-project.git
  2. Install Python dependencies with the command: pipenv install -r requirements.txt
  3. Create a .env file in the root directory using the .env.example provided
  4. Create the database using the commands: pipenv run flask db upgrade pipenv run flask seed all
  5. Change directory to react-app and run npm install and npm start
  6. Enjoy! ⭐