GitOpener 🚪🔓

🚀 Start your Open Source Journey! Contribute Today! 🤝

Table of Contents

• What is GitOpener?
• Learn Contributing 📖
• Become Contributor 👥
• How it works 🛠️
• How to create your profile 📝
• Contribution guide 🤝
  • Installation 🚧
  • Contributing Guidelines 📜
• 📝 License

What is GitOpener?

Git Opener is a beginner friendly open source project. This project serves as a guide to open source, with step by step information on how you can contribute. If you want to see your code in action, you're in the right place! 💻

Learn Contributing 📖

Everything you need to know to contribute to open source can be found here, from creating an issue to opening a pull request. Basic terminology can be found here! 📚

Become Contributor 👥

Contributors are featured on the web app. 👨‍💻👩‍💻

How it works 🛠️

Based on your contribution file your-github-username.mdx, GitOpener will authenticate you.

How to create your profile 📝

Installation steps are featured here.

If you want to skip the installation and create your profile directly, head over to docs.

Check out the contribution guidelines before contributing.

Contribution guide 🤝

Installation 🚧

This is a Next.js project bootstrapped with create-next-app

1. Fork the repo into your account 🍴
2. Clone the project into your local machine 🖥️

git clone https://github.com/<Your-GitHub-username>/gitopener.vercel.app.git

3. Navigate the folder 📂

cd gitopener.vercel.app

3. Install the dependencies 📦

   As Git Opener uses yarn package manager, it is recommended to use yarn, install yarn

yarn install

4. Make .env.local file in root directory with these variables 📁

   This step is optional, Do this step if you want to run complete application with database support

MONGO_URI= 'YOUR MONGODB CONNECTION STRING GOES HERE'
GITHUB_TOKEN= 'YOUR GITHUB TOKEN GOES HERE'

• Get mongodb connection string here: MONGODB DOCS
• Generate github token here: GITHUB TOKEN

5. Run the project on local machine

yarn dev

6. Every time you start making changes to your forked repo make sure it's in sync with the original repo

Contributing Guidelines 📜

Thank you for considering to contribute to this project.

What do I need to know to contribute? 🤔

This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this README section or the Documentation part of our project. 😊

If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below. 🔍

• ReactJS Official Docs
• NextJS Documentation
• Typescript Documentaion
• TailwindCSS Docs

How to make a Contribution? 🤝👩‍💻👨‍💻

Never made an open source contribution before? And wondering how to contribute to this project? 😕 No worries! Here's a quick guide, 🚀

1. Choose any feature/bug you wish to contribute to. 🎉
2. Fork the repository into your own account. 🍴
3. Clone the repo you have forked in your local machine using git clone https://github.com/<Your-GitHub-username>/gitopener.vercel.app.git
4. Create a new branch for your fix by using the command git checkout -b YourName-branch-name
5. Make the changes you wish to do and stage them using the command git add files-you-have-changed or use git add .
6. Use the command git commit -m "Short description of the changes" to describe the changes you have done with a message.
7. Push the changes to your remote repository using git push origin your-branch-name
8. Submit a PR(pull request) to the upstream repository pbclife/gitopener.vercel.app with a title and a small description. 🙏
9. Wait for the pull request to be reviewed by us. 🕰️
10. Make appropriate changes if the maintainer recommends you to and submit it. 🔄
11. Await for your contribution to be merged into the repository. 🎊

Checkout the Contributing.md file before contributing. 📖

📝 License

View Project License

This project is licensed under the terms of the MIT license. The MIT license is a permissive free software license that allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software. It is a simple and short license that is compatible with most open source licenses and is widely used in the open source community.

The MIT license includes a disclaimer of liability, meaning that the project's contributors cannot be held liable for any damages that may arise from the use of the software. It also requires that any copies or modifications of the software include the same license terms and copyright notice as the original software.

Thanks to all the Contributors ❤️

Your Support means a lot

Give a ⭐ to the project if you liked it. 😊