Skip to content

Kbart2401/ClimbInvest-app

Repository files navigation

ClimbInvest Documentation

Built with

Summary

ClimbInvest is a simulated stock trading platform that serves as a great risk-free exposure to the world of investing. Sign-up to be rewarded with an account worth $10,000 in simulated cash and trade your way to the top! Top performers ("Top Climbers") are highlighted on the home page as well as your current portfolio and a financial news feed. All prices are real-time via IEX Cloud Services api.

Features

Dynamic Landing Page

  • Changing image for every page visit

Screen Shot 2021-02-15 at 11 23 29 AM

Account Portfolio with real-time data via iex cloud api

  • Account totals are updated with every page visit and every trade placed
  • Get recent financial news on home page
  • See list of top 10 ClimbInvest investors

Screen Shot 2021-02-15 at 11 24 20 AM

Search for stocks and etfs with real-time data and historical 10 day chart

  • See if the market is currently open
  • 10 day chart rendered with Highcharts JS library

Screen Shot 2021-02-15 at 11 25 29 AM

Dynamic trade page allows you to buy stocks and etfs or sell what you currently have

  • Find valid stocks and etfs
  • Dynamic page responds to what stock you select and how many shares you currently own if any (with sell selection)

Screen Shot 2021-02-15 at 11 25 55 AM

Database Schema

Screen Shot 2021-02-08 at 11 32 37 AM


Usage

Demo User

There is a Demo login for those wishing to tour the site.

Contribution

If you would like to contribute to this project in any way, you may take the following steps

  1. Fork this repository
  2. Locally create a new branch git checkout -b <new branch name>
  3. Make updates and push branch up to repo git push -u origin <new branch name>
  4. Create a pull request - Please include clear details of changes

Reporting bugs

Please report any bugs/issues you may find via opening an issue in this repo

Development

Follow these steps if you need guidance on setting up and running a local server for this project

  1. Clone or fork this repo
  2. cd into backend and run npm install
  3. cd into frontend and run npm install
  4. Create a .env file in the backend directory and follow the .env.example files
  5. You will need to create a free account with iexcloud to get an api key
  6. Create a postgresql database according to the DB sections in .env.example
  7. Start your Express server from backend with npm start
  8. Start your React app from frontend with npm start

About

Gamified stock-picking app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages