Skip to content

Latest commit

 

History

History
143 lines (100 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

143 lines (100 loc) · 3.51 KB
Raw

👨‍🔧How to Contribute

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo and install the dependencies.
  • create a new branch for any issue that you might willing to work on.
  • make your valuable changes and finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements if needed.
  • Adding screenshots or screen captures to your Pull Request is a +1.

🤷‍♂️HOW TO INSTALL

Prerequisites

Before installation, please make sure you have already installed the following tools:

Installation

👉 Start by making a fork of the repository.

👉 Clone your new fork of the repository:

git clone https://github.com/<your-github-username>/linkpile-react

👉 Navigate to the new project directory:

cd linkpile-react

👉 install dependencies

npm install

👉 start emulators with

npm run emulators

👉 Run

npm start

🤷‍♀️HOW TO MAKE A PULL REQUEST:

Follow the above Installation setup, then

👉 Set upstream command:

git remote add upstream https://github.com/nathgoutam93/linkpile-react.git

👉 Create a new branch:

git checkout -b YourBranchName

👉 Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

😎 Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream

git merge upstream/main

📃 Github Docs for Syncing

👉 Make your changes to the source code.

👉 Stage your changes and commit:

git add .
git commit -m "<your_commit_message>"

👉 Push your local commits to the remote repository:

git push origin YourBranchName

👉 Create a Pull Request!

🎉🎊 Congratulations! You've made your first contribution to Linkpile! 🙌🏼

⚠ Facing problems while running Firebase emulators? ⚠

  • Firstly, Check if you have Java Installed.
  • If you have Java installed and still getting error!

try this:

👉 go to the firebase.json and edit the file as follows

"emulators": {
    "auth": {
      "port": 9099,
      "host": <your local Ip>
    },
    "firestore": {
      "port": 8188
      "host": <your local Ip>
    },
    "storage": {
      "port": 9199
      "host": <your local Ip>
    },
    "ui": {
      "enabled": true,
      "port": 4000
      "host": <your local Ip>
    }
  }

👉 after this go to ./src/lib/firebase.js and edit the file as follows

if (hostname === "localhost") {
  connectAuthEmulator(auth, "http://<your local Ip>:9099");
  connectFirestoreEmulator(db, "localhost", 8188);
  connectStorageEmulator(storage, "localhost", 9199);
}