pec-css / stock-watchlist Goto Github PK

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

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

• npm

  npm install npm@latest -g

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

• 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

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

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.

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

5. Navigate to the project directory.

cd Stock-Watchlist

6. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/PEC-CSS/Stock-Watchlist.git

7. Check the remotes for this repository.

git remote -v

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

9. Create a new branch(prefer a branch name that relates to your assigned issue).

git checkout -b <YOUR_BRANCH_NAME>

10. Perform your desired changes to the code base.

11. Check your changes.

git status

git  diff

12. Stage your changes.

git add . <\files_that_you_made_changes>

13. Commit your changes.

git commit -m "Commit Message"

14. Push the committed changes in your feature branch to your remote repository.

git push -u origin <your_branch_name>

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

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

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

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

1. Learn from Video
2. Open Source Guide

• Code of Conduct

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

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

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

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

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!

• React Native docs
• Expo Docs
• Messari API
• Let's build Tinder 2.0 with REACT NATIVE! (Messaging, ContextAPI, Tailwind, Google Auth, Firebase)
• Img Shields
• othneildrew / Best-README-Template

(back to top)