StalkStock

A virtual trading application.

Demo · Report Bug · Request Feature

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About StalkStock

StalkStock is a web application built in ReactJS to help new traders enter the trading world by allowing them to trade stocks in realtime using the virtual currency provided on signup. Users can bookmark their favourite stocks and observe them. StalkStock shows stock with realtime data with news related to them and various important terms related to them.

Built With

• React
• SASS
• Firebase
• ChartJS

Getting Started

To get a local copy of StalkStock up and running follow these simple steps.

Prerequisites

npm is required to start with local development.

• npm

  npm install npm@latest -g

Installation

1. Fork the repo and then clone the repo

   git clone https://github.com/your_username_/StalkStock.git

2. Install NPM packages

   npm install

3. Get the API keys from:

   • IEX API
   • FMP
   • Alpha Vantage

4. Create a .env file in the root directory. Enter your API in .env

   REACT_APP_IEX_KEY_1 = 'API KEY'
   REACT_APP_IEX_KEY_2 = 'API KEY'
   REACT_APP_IEX_KEY_3 = 'API KEY'
   REACT_APP_FMP_KEY = 'FMP API KEY'

   The same IEX API key can be used in all 3 API slots. This is just to not exhaust the monthly quota of API calls. Enter the FMP key in the file too. Use the Alpha Vantage API key in the dashboard.js file in the apiKeys array.

5. Create a Firebase project for web and enable the use of Firestore and Realtime DB. Enter the Firebase credentials in the .env file using the same variables used in auth.js.

6. Download the JSON file and import in Firebase Realtime DB. This is to limit the API calls to IEX Cloud.

Usage

StalkStock can be used by traders who want to enter the trading world, they can practice trading stocks here for free using virtual currency. It can also be used by traders who want to keep a watch on some stocks in the market.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - Aryan Yadav - aryan2019@iiitkottayam.ac.in

Project Link: https://github.com/starwiz-7/StalkStock