Skip to content

Azerbaijan-Git-Community/showcase

Repository files navigation

Azerbaijan Github Community Showcase

A curated registry of open-source projects built by Azerbaijan GitHub Community members.

Browse the live showcase at githubcommunity.az/showcase.

Website · Linkedin · Telegram · Instagram



Submit Your Project

Requirements

  • The repository must be public on GitHub
  • You should be the owner or an active contributor of the project

Steps

  1. Fork this repository
  2. Create a new file in the projects/ directory named {owner}-{repo}.yaml
    • Replace {owner} and {repo} with the GitHub owner and repository name
    • Example: for octocat/hello-world, the filename is octocat-hello-world.yaml
  3. Fill in the fields (see schema below)
  4. Open a pull request against main

A CI check will validate your file automatically. Fix any reported errors before requesting review.

Schema

repo: owner/repo # Required — GitHub owner/repo slug
submittedBy: your-github-username # Required — your GitHub username
banner: https://... # Optional — banner image URL (HTTPS)
links:
  # Optional — package registry / marketplace URLs
  - https://www.npmjs.com/package/my-package
  - https://pypi.org/project/my-package
website: https://myproject.com # Optional — project's own website or docs (HTTPS)
Field Required Description
repo Yes GitHub repository in owner/repo format
submittedBy Yes Your GitHub username
banner No Banner image URL (HTTPS only). If it fails to load, the GitHub OG image is shown as fallback. Recommended size: 1280×640px
links No List of HTTPS URLs to package registries or marketplaces (max 5)
website No Your project's own website or documentation site (HTTPS). Do not put npm, PyPI, or other registry/host links here — those belong in links. If your project doesn't have its own website, leave this field out.

links

Each entry is a plain HTTPS URL — no labels or extra fields needed. The website automatically picks the right icon based on the URL domain.

Use links for package registries and marketplaces (npm, PyPI, crates.io, etc.). Use website only for the project's own website or docs — not for registry or third-party hosting links.

Recognized domains and their icons:

Domain Icon
npmjs.com npm
pypi.org Python / PyPI
marketplace.visualstudio.com VS Code Marketplace
open-vsx.org Open VSX
crates.io Rust / crates.io
rubygems.org RubyGems
nuget.org NuGet
hub.docker.com Docker Hub
pub.dev Dart / pub.dev
pkg.go.dev Go / pkg.go.dev
hex.pm Elixir / hex.pm
packagist.org PHP / Packagist
anaconda.org Anaconda
mvnrepository.com Maven
cocoapods.org CocoaPods
jsr.io JSR (Deno)
plugins.jetbrains.com JetBrains Marketplace
chromewebstore.google.com Chrome Web Store
addons.mozilla.org Firefox Add-ons
aur.archlinux.org AUR (Arch Linux)
snapcraft.io Snap Store
flathub.org Flathub
search.nixos.org NixOS
formulae.brew.sh Homebrew
ghcr.io GitHub Container Registry

Any other domain shows a generic link icon — you don't need to wait for support to be added.

Examples

npm packageprojects/octocat-hello-world.yaml

repo: octocat/hello-world
submittedBy: octocat
links:
  - https://www.npmjs.com/package/hello-world
website: https://hello-world.example.com

VS Code extension

repo: octocat/my-extension
submittedBy: octocat
banner: https://raw.githubusercontent.com/octocat/my-extension/main/banner.png
links:
  - https://marketplace.visualstudio.com/items?itemName=octocat.my-extension

Python library on multiple registries

repo: octocat/mylib
submittedBy: octocat
links:
  - https://pypi.org/project/mylib
  - https://anaconda.org/conda-forge/mylib

After your PR is merged, a webhook notifies the website to sync your project's GitHub metadata (stars, issues, PRs, license, language). Your project card appears on the showcase within minutes.

To update optional fields later, open a new PR editing your existing YAML file.

How It Works

  • Members submit YAML files describing their projects via pull requests
  • A CI workflow validates the schema on every PR
  • On merge, a webhook notifies the website, which syncs GitHub metadata (stars, issues, PRs, license, language) into its database
  • The /showcase page renders project cards from this data

About

A curated registry of open-source projects built by Azerbaijan GitHub Community members.

Topics

Resources

Code of conduct

Stars

3 stars

Watchers

1 watching

Forks

Contributors