diff --git a/README.md b/README.md index 614dc4555..bf2f74e2f 100644 --- a/README.md +++ b/README.md @@ -9,27 +9,47 @@ LinksHub is a Hub of Links `For Developers By Developers`. Here, we've gathered a collection of all the best and most useful resources, both free and paid, to aid in the development journey. We recognize that there's a wealth of information available, but often, it's a matter of knowing where to find it. That's why we've made it our mission to bring the right resources to the right developers. + + +## Outreach + +We are passionate about helping people from all backgrounds start their open source journey. Here are some initiatives that we have partaken in: + + + + + + + + + + + +
NameLogoPurpose
GirlScript Summer of Code 2023 a white background with the text, GirlScript Summer of Code next to an orange flower 3-month summer +open source program with a mission to help students from India and beyond in developing their technical skills
## Table of Contents - [Welcome to LinksHub πŸ‘‹](#welcome-to-linkshub-) -- [Demo πŸ’»](#demo-) -- [Tech stack πŸ“š](#tech-stack-) -- [Socials πŸ“±](#socials-) -- [Getting Started πŸ‘©β€πŸ’»](#getting-started-) - - [Let's jump right in🌟](#lets-jump-right-in) - - [_Want to add your favorite links to the Hub? make sure to follow CONTRIBUTING guidelines._](#want-to-add-your-favourite-links-to-the-hub-make-sure-to-follow-contributing-guidelines) - - [Want to add or update the descriptions of subcategories?](#want-to-add-or-update-the-descriptions-of-subcategories) -- [Building with Gitpod πŸ’£](#building-with-gitpod-) -- [Top 50 Contributors ✨](#top-50-contributors-) -- [License πŸ“](#license-) -- [Support ⭐](#support-) + - [Outreach](#outreach) + - [Table of Contents](#table-of-contents) + - [Demo πŸ’»](#demo-) + - [Tech stack πŸ“š](#tech-stack-) + - [Socials πŸ“±](#socials-) + - [Getting Started πŸ‘©β€πŸ’»](#getting-started-) + - [Let's jump right in🌟](#lets-jump-right-in) + - [_Want to add your favorite links to the Hub? make sure to follow CONTRIBUTING guidelines._](#want-to-add-your-favorite-links-to-the-hub-make-sure-to-follow-contributing-guidelines) + - [Want to add or update the descriptions of subcategories?](#want-to-add-or-update-the-descriptions-of-subcategories) + - [Building with Gitpod πŸ’£](#building-with-gitpod-) + - [Top 50 Contributors ✨](#top-50-contributors-) + - [License πŸ“](#license-) + - [Support ⭐](#support-) ## Demo πŸ’» -You can see the live demo at: https://linkshub.vercel.app +You can see the live demo at: @@ -100,14 +120,19 @@ You can see the live demo at: https://linkshub.vercel.app ``` > **P.S**: If you have `docker` installed in your system, you can follow these steps to set up the environment: +> > 1. After forking and cloning the repo(as mentioned above), get into the project directory: +> > ```bash > cd LinksHub/ > ``` +> > 2. Start the docker container with: -> ```bash +> +> ```bash > docker-compose up > ``` +> > 3. Now start adding your changes. > **Note:** You don't need to restart the container again and again after starting it once, because the changes you make will reflect in the container instantly. @@ -138,6 +163,7 @@ You can see the live demo at: https://linkshub.vercel.app #### _Want to add your favorite links to the Hub? make sure to follow [CONTRIBUTING guidelines](https://github.com/rupali-codes/linkshub/blob/main/CONTRIBUTING.md)._ #### Want to add or update the descriptions of subcategories? + Make sure to follow [CONTRIBUTING guidelines](./CONTRIBUTING.md#Adding-and-Updating-Category-Description-). --- diff --git a/public/gssoc-logo.png b/public/gssoc-logo.png new file mode 100644 index 000000000..1f2433cf8 Binary files /dev/null and b/public/gssoc-logo.png differ