Skip to content

Latest commit

 

History

History
216 lines (163 loc) · 7.81 KB

README.md

File metadata and controls

216 lines (163 loc) · 7.81 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Stock-Watchlist

Completly Open-Source | Free To Use | Ad-Free

Asset Watchlist Application for Stocks (NSE & BSE), Cryptocurrencies, Options and Indexes.

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Login Screen Stock Screen and Watchlist About and Profile Screen Search Screen

Built With

   

Getting Started

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

Prerequisites

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can install and set up your app.

  1. Clone the repo
    git clone https://github.com/PEC-CSS/Stock-Watchlist.git
  2. Install NPM packages
    npm install

Usage

  • Start the project
    npm start
  • To see changes:
    • Browser - click on Run in web browser and use 'Ctrl+Shift+M' to toggle mobile view
    • Mobile - Scan the QR Code. (make sure Expo Go app is installed on your phone)

For more examples, please refer to the Documentation

Contributors

This project exists thanks to all the people who contribute. [Contributing].

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

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

Be sure to read the contribution guidelines before contributing.

License

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

Contact

Rahul Sharma - [email protected] - [email protected]

Project Link: https://github.com/PEC-CSS/Stock-Watchlist

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)