Skip to content
 
 

Repository files navigation

Paper Trader

Main Page

Project for Week 16 at the coding school, Epicodus, written on August 29, 2019.

By Josh Mabry, Hugh Donkin, Tae Lee, and Alex Siegberg

Description

This app tracks real stocks in real-time and allows users to buy and sell stocks with fake currency. There's a leaderboard to track which user has profited the most from their stock purchases. The technologies we utilized was Ruby on Rails, JavaScript and Postgres with the Alpha Vantage API service for real-time stock information.

MVP Goals

  • View the price of a stock over time
  • View prices of many stocks over time
  • View a graph indicating the relative stock price
  • Track a portfolio of many stocks over time
  • "Buy" and "Sell" stocks of your portfolio
  • Indicate relevant stats about your portfolio
  • Leaderboards showing increases and decreases in portfolio (edited)

Setup/Installation Requirements

For demonstration only, locate this address (http://floating-scrubland-71604.herokuapp.com/) on your browser.   _For local deployment : _

  • Clone this repository

  • Open terminal and type 'git clone [git link]'

  • Navigate to project directory using cd in terminal

  • Open project in text editor (atom .)

  • Type 'bundle install' in terminal to load Gems

  • postgres DB installation with sql script in project

  • rake db:create

  • rake db:migrate

  • rake db:seed

  • rails s

  • open browser and locate localhost:3000

  • For database, in order to backup, please execute followings in terminal:

  • pg_dump [YOUR DATABASE NAME] > database_backup.sql

  • for database restore after clone, please execute followings in terminal

  • createdb [DATABASE NAME]

  • psql [DATABASE_NAME] < database_backup.sql

  • createdb -T [DATABASE NAME] [TEST DATABASE NAME]

Known Bugs

No known bugs

Support and contact details

Please contact us if you have any issues at: [email protected]

Technologies Used

  • Ruby 2.5.1
  • Rails 5.2.3
  • Postgres DB 10.5
  • JavaScript ES6
  • Heroku 7.29
  • Gems (turbolinks, jbuilder, dotenv-rails, rest-client, sass-rails, devise, money, alphavantagerb, faker ...)
  • API information for real stock market from Alpha Vantage (https://www.alphavantage.co/)

License

This software is licensed under MIT license.

Copyright (c) 2019 Josh Mabry, Hugh Donkin, Tae Lee, and Alex Siegberg

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages