Skip to content

Commit

Permalink
feat(update readme): added introduction on readme, and some screensho…
Browse files Browse the repository at this point in the history
…ts (#75)
  • Loading branch information
Aadarsh805 committed Feb 12, 2023
1 parent 06c4d31 commit 749916e
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 12 deletions.
48 changes: 36 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# GitOpener

<img src="/public/images/readme/landingPage.png" alt="GitOpener Landing Page" style="border-radius: 10px"/>

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

<img src="/public/images/readme/guidesPage.png" alt="GitOpener Guides Page" style="border-radius: 10px"/>

#### Become Contributor

<!-- -->

<img src="/public/images/readme/contributorsPage.png" alt="GitOpener Contributors Page" style="border-radius: 10px"/>

#### How it works

Based on your contribution file `your-github-username.mdx` GitOpener authenticates you.

<img src="/public/images/readme/profilePage.png" alt="GitOpener Profile Page" style="border-radius: 10px"/>

#### 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)

<!-- Descrption -->

Checkout out [contribution guidelines][contributing] before you start with contributions
Expand All @@ -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
Expand All @@ -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'
Expand All @@ -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)
Expand All @@ -86,28 +115,23 @@ No worries! Here's a quick guide,

Checkout the [Contributing.md][contributing] file before contributing.


<!-- ### Where can I go for help? -->


## License

[MIT][license]


## Thanks to all the Contributors ❤️

<a href = "https://github.com/pbclife/gitopener.vercel.app/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=pbclife/gitopener.vercel.app"/>
</a>


## 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
Binary file added public/images/readme/contributorsPage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/readme/guidesPage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/readme/landingPage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/readme/profilePage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 749916e

@vercel
Copy link

@vercel vercel bot commented on 749916e Feb 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.