hasnainmakada-99 / Open-Source-With-Hasnain

Welcome to 'Open Source with Hasnain' – your one-stop hub for free, beginner-friendly tech resources across various stacks. Join us in building your skills and making a difference. Contribute and learn as you explore the vast world of technology. Let's grow together!
https://hasnainmakada-99.github.io/Open-Source-With-Hasnain/
MIT License
84 stars 77 forks source link

[Add]: Guide on how to run this project locally on host machine #166

Closed hasnainmakada-99 closed 1 year ago

hasnainmakada-99 commented 1 year ago

Describe the bug There is a Requirement to add a guide on how to run this project locally on machine, So I would like to request to the contributor that they should add the guide inside this project

To Reproduce None

Expected behavior None

Screenshots None

Additional context None

github-actions[bot] commented 1 year ago

Hey! contributor, thank you for opening an Issue 🎉.

Soon one of our maintainers will review it and provide you with feedback/suggestions. If you think it's something urgent, feel free to reach out Hasnain Makada on Twitter. Star ⭐ this repo to show us support.

Happy, Open Source!

Madhurchandran commented 1 year ago

first : git clone of the repository which you wanted to run in your local machine then install the dependencies, then update the configurations. Reference

  1. https://www.neonscience.org/resources/learning-hub/tutorials/github-git-clone (Detail visualize overview)
  2. https://dev.to/ceceliacreates/how-to-run-a-project-from-github-locally-30d1
hasnainmakada-99 commented 1 year ago

Thanks for providing us with some resources @Madhurchandran, But actually we are seeking someone who could write the guide in a markdown file for us 😄

Madhurchandran commented 1 year ago

I want to try this can you explain it, hint.

hasnainmakada-99 commented 1 year ago

I want to try this can you explain it, hint.

Sure @Madhurchandran, This project is based on docsify, so now you have to write out a guide in markdown language with good design on how new contributors can run this project in their machine, basically set up the project in their machine

If you have any more queries, feel free to reach me here 😄

Madhurchandran commented 1 year ago

@hasnainmakada-99 what you want new file about version control, in this project can you give me more detail what should write prequisites any programming language requirenment, i want to try this.

hasnainmakada-99 commented 1 year ago

No @Madhurchandran, I am saying like to add a guide like a readme file specifically targeting first-time users, so that whoever any new contributor comes to this project, they can run the project inside their local machine by just following the guide

For example, have a look at this guide of link free 👇🏻 https://linkfree.io/docs/quickstart-json

Madhurchandran commented 1 year ago

@hasnainmakada-99 you already have file contributing.md so you want changes in that file or new file

hasnainmakada-99 commented 1 year ago

A new File @Madhurchandran