README.md

StalkStock

An awesome Stock Market Investment Simulator!

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • Usage
3. Roadmap
4. Contributing
5. License

About The Project

Motivation: Stock market is still an enigma for a lot of people. And even though you can study about it and think you understand it enough to take the first step, it is always difficult to buy that first stock. Because every investment comes with an attached expectation of profit, and it is not an unfair expectation. Hence we wanted to simulate the experience of stock market without the need to spend real money.

Our Solution: We made an android application that

• uses real time stock APIs to simulate the stock market.
• provides user with accounts and a certain amount of money to start with.
• provides option of browsing and monitoring different stocks.
• allows buying and selling of stocks as per will, with the aim of maximizing profit.
• gives a dashboard to make it all easily accessible.

Built With

• React Native
• React Native Paper
• Alpha Vantage API
• IEX API

Getting Started

Follow the instructions given below to get started with out app.

Installation

Follow the steps below:

• Make sure you have npm and nodejs installed in your pc.
• Clone the repository.
• Open terminal and navigate to the project folder.
• execute the following commands.
• npm install
• npx react-native run-android

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.