Skip to content

Commit

Permalink
Add Installation and Running Instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
lovelymahor committed Aug 2, 2024
1 parent b55d33d commit b456b42
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,23 @@ Contributions are always welcome! Follow these steps to get started:
```sh
git checkout -b <your_branch_name>
```

8. **πŸ› οΈ Install dependencies.**
```sh
npm install
```
9. **πŸ“Š Run the Application.**
```sh
npm run dev
You are all set! πŸŽ‰
8. **πŸ› οΈ Perform your desired changes to the code base.**
10. **πŸ› οΈ Perform your desired changes to the code base.**
9. **πŸ“Š Track your changes.**
```sh
git add .
```
11. **πŸ“Š Track your changes.**
```sh
git add .
```

10. **πŸ’¬ Commit your changes with a relevant commit message.** For example, if you added a new feature, you could use:
12. **πŸ’¬ Commit your changes with a relevant commit message.** For example, if you added a new feature, you could use:
```sh
git commit -m "Add feature X"
```
Expand All @@ -107,14 +113,14 @@ You are all set! πŸŽ‰
git commit -m "Fix issue Y"
```

11. **πŸš€ Push the committed changes in your feature branch to your remote repo.**
13. **πŸš€ Push the committed changes in your feature branch to your remote repo.**
```sh
git push -u origin <your_branch_name>
```

12. **πŸ”„ To create a pull request,** go to your forked repository on GitHub and click on `Compare & pull request`. Ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.
14. **πŸ”„ To create a pull request,** go to your forked repository on GitHub and click on `Compare & pull request`. Ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.

13. **πŸŽ‰ Voila!** You have made a PR to the StartConnect-Hub project. Sit back patiently and relax while the project maintainers review your PR.
15. **πŸŽ‰ Voila!** You have made a PR to the StartConnect-Hub project. Sit back patiently and relax while the project maintainers review your PR.

---

Expand Down

0 comments on commit b456b42

Please sign in to comment.