Skip to content

Naman-2001/Stonks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stonks - Team Bandito - inGenius 2020

Stock market simplified

DOCS UI DEMO PPT

Features

  • Track both how a particular news headline affects a stock and which particular stocks are in news on any given day.
  • The stocks in news can also be tracked to monitor their financial performance on a particular day, based on the news
  • The user is also notified when the price of a particular company’s stocks are expected to fall or rise based on the current world news, via email.
  • Stonks also allows you to analyze financial reports of a company to understand if it's profitable to invest in its stock
  • See relevant cryptocurrency news and how each and how the cryptocurrency market is performing as a whole

Instructions to run the backend

$ git clone https://github.com/Naman-2001/Stonks.git
$ cd Stonks
$ cd backend
$ npm install

These variables should reside as key value pairs in a file called .env.

Variable Name Description Get it from
NATURAL_LANGUAGE_UNDERSTANDING_APIKEY IBM Watson API KEY https://cloud.ibm.com/
NATURAL_LANGUAGE_UNDERSTANDING_IAM_APIKEY IBM Watson IAM API KEY https://cloud.ibm.com/
NATURAL_LANGUAGE_UNDERSTANDING_URL IBM Watson NLU Service URL https://cloud.ibm.com/
NATURAL_LANGUAGE_UNDERSTANDING_AUTH_TYPE IBM Watson NLU Auth Type https://cloud.ibm.com/
NEWS_APIKEY NEWSAPI API KEY https://newsapi.org/account
DBURI URI for connecting to MongoDB Atlas https://cloud.mongodb.com/
JWT_SECRET JWT Secret Key You can generate your own key
SENDGRID_API_KEY Sendgrid API KEY https://app.sendgrid.com/
SENDGRID_EMAIL Email for sending out mails from Sendgrid https://app.sendgrid.com/
$ npm start

Instructions to run the frontend

$ git clone https://github.com/Naman-2001/Stonks.git
$ cd Stonks
$ cd frontend
$ npm install
$ npm start

Tech Stack and Services used

  • MERN STACK for the application
  • Sendgrid for sending emails
  • IBM Watson NLU Library
  • Heroku for deployments

Contributors

License

License