/Stock-Watchlist

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

Primary LanguageJavaScriptMIT LicenseMIT

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. How to Contribute
  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
    or 
    npm install --legacy-peer-deps

Usage

  • Start the project 
    npx expo 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)
  • Create a new build 
    eas build --profile preview --platform android

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".

Be sure to read the contribution guidelines before contributing.

Follow below steps to make your contribution count.

🖱️ How to Contribute

If you think that you can add a new feature or want to fix a bug, we invite you to contribute to Stock-Watchlist and make this project better. To start contributing, follow the below instructions:

  1. Create a folder at your desire location (usually at your desktop).

  2. Open Git Bash Here

  3. Fork the project. Click on the icon in the top right to get started.

  4. Clone your forked repository of project.

git clone https://github.com/PEC-CSS/Stock-Watchlist.git
  1. Navigate to the project directory.
cd Stock-Watchlist
  1. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/PEC-CSS/Stock-Watchlist.git
  1. Check the remotes for this repository.
git remote -v
  1. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.
git pull upstream main
  1. Create a new branch(prefer a branch name that relates to your assigned issue).
git checkout -b <YOUR_BRANCH_NAME>

  1. Perform your desired changes to the code base.

  2. Check your changes.

git status
git  diff
  1. Stage your changes.
git add . <\files_that_you_made_changes>
  1. Commit your changes.
git commit -m "Commit Message"
  1. Push the committed changes in your feature branch to your remote repository.
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests.

  2. Add an appropriate title and description to your PR explaining your changes.

  3. Click on Create pull request.

Congratulations🎉, you have made a PR to the Stock-Watchlist. Wait for your submission to be accepted and your PR to be merged by a maintainer.

🫴 How to Do Your First Pull Request?

(We are providing some Resource from where you can Learn)

  1. Learn from Video
  2. Open Source Guide

Code of Conduct

🙏🏽 Support

This project needs a star️ from you. Don't forget to leave a star✨ Follow my Github for content

© PEC ACM CSS

License

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

Contact

Rahul Sharma - acmcss@pec.edu.in - rahul2702sharma@gmail.com

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)