diff --git a/README.md b/README.md index 9177dd2..c776c3e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,37 @@ # GitOpener +GitOpener Landing Page + +Great Place To Start Open-Source Journey. Contribute Today + +#### What is GitOpener? + +Git Opener is a open source project for everyone. If you are looking for a good project to get started with open source and you want to see your code in action then you are in the right place. + +#### Learn Contributing + +From creating an issue to to open a pull request, everything got covered. The basic things you need to know is the terminologies. If you are curious you definately checkout these + +GitOpener Guides Page + +#### Become Contributor + + + +GitOpener Contributors Page + +#### How it works + +Based on your contribution file `your-github-username.mdx` GitOpener authenticates you. + +GitOpener Profile Page + +#### How to create your profile + +Let's start with the installation + +Or If you wanna skip the installation and create your profile directly, head over to [docs](docs/guides/starting-contribution/getting-started.mdx) + Checkout out [contribution guidelines][contributing] before you start with contributions @@ -11,9 +43,7 @@ Checkout out [contribution guidelines][contributing] before you start with contr > This is a Next.js project bootstrapped with create-next-app 1. Fork the repo into your account - -![Fork Image](https://i.imgur.com/mNw6zxu.png) - + ![Fork Image](https://i.imgur.com/mNw6zxu.png) 2. Clone the project into your local machine ```sh @@ -27,14 +57,14 @@ cd gitopener.vercel.app ``` 3. Install the dependencies - > As Git Opener uses yarn package manager, it is recommended to use yarn, [install yarn][yarn-website] + > As Git Opener uses yarn package manager, it is recommended to use yarn, [install yarn][yarn-website] ```sh 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 + > 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' @@ -59,7 +89,6 @@ 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](https://reactjs.org/docs/getting-started.html) @@ -86,28 +115,23 @@ No worries! Here's a quick guide, Checkout the [Contributing.md][contributing] file before contributing. - - ## License [MIT][license] - ## Thanks to all the Contributors ❤️ - ## Your Support means a lot Give a ⭐ to the project if you liked it. :) - [yarn-website]: https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable [mongodb-docs]: https://www.mongodb.com/docs/compass/current/connect [github-token]: https://github.com/settings/tokens [contributing]: https://github.com/pbclife/gitopener.vercel.app/blob/main/CONTRIBUTING.md -[license]:https://github.com/pbclife/gitopener.vercel.app/blob/main/LICENCE +[license]: https://github.com/pbclife/gitopener.vercel.app/blob/main/LICENCE diff --git a/public/images/readme/contributorsPage.png b/public/images/readme/contributorsPage.png new file mode 100644 index 0000000..8add591 Binary files /dev/null and b/public/images/readme/contributorsPage.png differ diff --git a/public/images/readme/guidesPage.png b/public/images/readme/guidesPage.png new file mode 100644 index 0000000..d2eb571 Binary files /dev/null and b/public/images/readme/guidesPage.png differ diff --git a/public/images/readme/landingPage.png b/public/images/readme/landingPage.png new file mode 100644 index 0000000..3d8f76a Binary files /dev/null and b/public/images/readme/landingPage.png differ diff --git a/public/images/readme/profilePage.png b/public/images/readme/profilePage.png new file mode 100644 index 0000000..dc2c2f6 Binary files /dev/null and b/public/images/readme/profilePage.png differ