Open-Source Hub
Welcome to Open-Source Hub! This website and community connects open source maintainers and collaborators. Please join our Discord channel if you have any questions or just want to chat!
Project setup
Requirements:
- Node v14 or above
- Yarn:
npm install --global yarn
First-time setup:
- check out this repository and navigate into it with
cd opensourcehub - install the dependencies:
yarn - copy the contents of
.env.sampleto a.envfile
yarn dev
github.dev environment
You can also contribute to OSH without having to run the app on your local machine! Go ahead and check out the github.dev steps below.
If you have a JavaScript development environment set up already and prefer to run locally, the approach will be familiar.
- Create a fork of the OSH.
- Once on your fork's page, either press the full stop
.key or replace.comin the location bar in your browser to.dev.
Now you're in the github.dev editor! Feel free to hop ahead to our contributing section.
For more information on the Github.dev editor, please see their docs.
How to list your project
- Get the project up and running first
- Create your project's
.mdxfile:- Create a new folder inside
/public/projects/and name it the same as your GitHub handle or organization - Add a new
.mdxfile to that folder, and give it the name of your public repo. For example,- if your project URl is:
https://github.com/Codesee-io/opensourcehub - you would create:
/public/projects/Codesee-io/opensourcehub.mdx.
- if your project URl is:
- Copy/paste the contents of
/public/projects/_template.mdxinto that file
- Create a new folder inside
- Fill out the information — most of it is optional, but extremely helpful for potential contributors. If you opt not to include the optional content, delete it from your template.
- Add a 200x200 image for your organization to your folder, for example,
./public/projects/distributeaid/da.png - Preview your changes by running
yarn dev - When you're ready, open a PR!
How to add a CodeSee Map to your project listing
Make it easier for contributors to onboard to your project! With a CodeSee Map, they can visualize the entire codebase, with features allowing them to explore system dependencies, add additional context to pull requests, and more.
To add a Map to your project:
- Sign up for CodeSee Maps (there's no commitment or cost!)
- Create a Map for your repo following our instructions
- Set your map to public!
- Add an entry in your project's template for the Map (see example from Distribute Aid's Shipment Tracker project):
featuredMap:
url: https://app.codesee.io/maps/public/848e3630-1650-11ec-8bc1-7d4a4822cc27
description: Get a quick overview of the major areas of our repo
If you would like to display multiple maps you can add an entry called "maps"
maps:
- url: https://app.codesee.io/maps/public/848e3630-1650-11ec-8bc1-7d4a4822cc27
description: Get a quick visual overview of the major areas of our repo!
subTitle: devdocs
- url: https://app.codesee.io/maps/public/848e3630-1650-11ec-8bc1-7d4a4822cc27
description: Another map!
subTitle: testMap
That's it!
The CodeSee Map below is a good way to get familiar with the codebase:
Contributing
First and foremost, all contributors must read and agree to our code of conduct.
Then, the best way to get started is to create an issue and tag one of the maintainers.
Technical documentation
- "How this works" explains the architecture of this project
- Learn how we use Firebase
Content
Tag policy
Final tags are up to the maintainers of Open-Source Hub. Your tags may be modified for the benefit of the community and to improve discoverability.
We use title-casing for tags. For example: "First-Timer Friendly, Social Activism, C#, JavaScript".
How to remove your project from Open-Source Hub
Open a PR to remove your project folder from this repository.
Notes
- Please pin the exact version of dependencies
![[Snyk] Security upgrade firebase-admin from 10.3.0 to 11.4.1](https://avatars.githubusercontent.com/u/19733683?v=4)
| 671/1000 
| 611/1000 
3 Oct 21, 2022
3 Nov 6, 2022
7 Oct 30, 2022
3 Aug 17, 2022
4 Oct 13, 2022
262 Dec 27, 2022
3 Sep 22, 2022
3 Oct 5, 2022
9 Jan 1, 2023
7 Oct 25, 2022
9 Sep 17, 2022
9 Nov 12, 2022
3 Nov 19, 2022
4 Sep 22, 2022
5 Sep 11, 2022
78 Dec 16, 2022
76 Dec 29, 2022
45 Jul 19, 2022
5 Mar 7, 2022