Explore G-Research's open-source projects and learn more about our Open Source Program Office.
This repository contains the source code for the G-Research organization website.
The website is built using Gatsby, hosted on GitHub Pages, and published at g-research.github.io/.
- Showcases G-Research's open-source projects
- Automatically collects and processes repository data from the GitHub API
- Allows custom overrides for repository information
- Supports custom logos for repositories
The website automatically fetches data for G-Research's open-source projects from the GitHub API. This data is processed
and stored in the static/data/ directory in JSON format, which is then used to generate the website.
You can customize the information for specific repositories by adding entries
to static/data/custom_values.json where the key is the repository's full name and
the value is an object containing the data to override. This is especially useful for:
- Setting Discord URLs, Slack URLs, website URLs...
- Adding custom descriptions
When overriding data, ensure you follow the schema defined in src/core/types/index.ts.
To use a custom logo for a repository:
- Create an SVG file named after the repository
- Place it in a folder named after the organization within the
static/hosted_logos/directory - Make sure all folder and file names are lowercase
Example:
For the repository G-Research/g-research.github.io, the custom logo should be located
at: static/hosted_logos/g-research/g-research.github.io.svg.
Custom logos will be used instead of the organization's GitHub avatar.
This project is built using Gatsby, a React-based static site generator. It uses TypeScript and Mantine UI components.
yarn installyarn developYour site is now running at http://localhost:9000!
Edit your code to see your site update in real-time!
This project is licensed under the MIT License.