Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 3.55 KB

README.md

File metadata and controls

92 lines (72 loc) · 3.55 KB

Fantasy Portfolio League

Netlify Status

Table of Contents

  1. Introduction
  2. Demo
  3. Technical Details
  4. Installation
  5. Contact
  6. License

Introduction

While the retail investors are investing a majority of them are completely new to the Stocks Market and so there lies an opportunity to provide a platform for them to learn by investing without substantially losing their hard earned money.

Fantasy Premier League (FPL) is a stock portfolio challenge platform. Each challenge will have a criteria to select and create a portfolio of 5 stocks. The challenge has a cut off date, before which participants can submit their portfolio and an end date on which the user with maximum return on the portfolio will be rewarded in the form of coupons and discounts.

To participate in the challenge the users will have to subscribe to the app. Once subscribed, they will be provided with more tickets each month for the challenges that month. With 1 ticket they can participate in 1 challenge.

Workflow Walkthrough - Demo

Walkthrough

Demo Credentials

app : Fantasy Portfolio League https://fpleague.netlify.app
username: demo@pesto.com
password: demopresto

Technical Details

Technologies and API's

Tech / API Description
Sentry Capture logs of the site
TradingView Charting and Stock Details Application
AlphaVantage Stock Search and Base Price Data
Yahoo Finance To stream live market price
Firebase Authentication User and Login Management
Firebase Firestore Application Database
Firebase Realtime Database Live calculations
Nodejs Application Server

Tools and Libraries

Library Description
reactjs Frontend Library
redux State Management Library
material ui Base UI framework
redux persist Persist redux state to Browser Local Storage
axios API call and management
firebase access and integrate firebase services
alphavantage access aplhavantage api
react-circular-progressbar used for challenge status component

Env variables

Please Note: All env variables to be prepended with REACT_APP

Variable Description
GOOGLE_API_KEY firebase access key
GOOGLE_AUTHDOMAIN firebase authdomain key
GOOGLE_PROJECTID firebase project id
GOOGLE_STORAGEBUCKET firebase storage bucket
GOOGLE_MESSAGING_SENDERID firebase key for notifications
GOOGLE_APPID google app id
GOOGLE_MEASUREMENTID google measurement key for resource use measurement
API_SERVER nodejs deployment
ALPHAVANTAGE_KEY alphavantage api key
ALPHAVANTAGE_URL alphavantage url
DATABASE_URL firebase realtime database url

Installation

Deloy fpl-frontend app

git clone https://github.com/pesto-students/n8-fpl-eta-fe.git
cd n8-fpl-eta-fe
npm install
npm start

Please Note: to deploy the frontend on local backend server please change the REACT_APP_API_SERVER to localhost:8080

Contact

Madan Patro
Neil Doshi

License

MIT
The code has been opensourced for others to view and fork .