## 1. Project Overview & Quickstart (gitify-app/gitify) # Gitify [![CI Workflow][ci-workflow-badge]][github-actions] [![Release Workflow][release-workflow-badge]][github-actions] [![Coverage][coverage-badge]][coverage] [![Quality Gate Status][quality-badge]][quality] [![Renovate enabled][renovate-badge]][renovate] [![Contributors][contributors-badge]][github] [![Downloads - Total][downloads-total-badge]][website] [![Downloads - Latest Release][downloads-latest-badge]][website] [![OSS License][license-badge]][license] [![Latest Release][github-release-badge]][github-releases] [![Homebrew Cask][homebrew-cask-badge]][homebrew-cask] > Git Notifications on your menu bar. Available on macOS, Windows and Linux. ![Gitify][gitify-social] --- ## Features - ๐Ÿ”” Unified notifications from your Git platforms - โš’๏ธ Multi-forge: GitHub Cloud, GitHub Enterprise, Gitea, Forgejo, Codeberg, Bitbucket Cloud - ๐Ÿ’ป Cross-platform: macOS, Windows, and Linux - ๐ŸŽจ Customizable settings, filters and themes - ๐Ÿ–ฅ๏ธ Tray/menu bar integration - โšก Fast, native experience ## Supported forges Gitify uses a forge adapter pattern so notifications can come from any compatible Git forge, not just GitHub. | Forge | Status | Notifications | Mark read | Mark done | Unsubscribe | Enriched details | | ----------------------------------------------- | ------ | :-----------: | :-------: | :-------: | :---------: | :--------------: | | **GitHub** Cloud | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | | **GitHub** Enterprise Server (< 3.13) | โœ… | โœ… | โœ… | โŒ | โœ… | โœ… | | **GitHub** Enterprise Server (โ‰ฅ 3.13) | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | | **GitHub** Enterprise Cloud with Data Residency | โœ… | โœ… | โœ… | โœ… | โœ… | โœ… | | **Gitea** (incl. Forgejo, Codeberg) | โœ… | โœ… | โœ… | โ€” | โ€” | โ€” | | **Bitbucket** Cloud | โœ… | โœ… | โœ… | โ€” | โ€” | โ€” | | **GitLab** (todos) | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | | **Azure DevOps** | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | | **Gerrit** | ๐Ÿ’ญ | โ€” | โ€” | โ€” | โ€” | โ€” | **Status legend** | Symbol | Meaning | | ------ | ------------------------------------------------ | | โœ… | Supported | | โŒ | Unsupported | | ๐Ÿงช | Experimental (rough edges expected) | | ๐Ÿšง | In progress (adapter is being worked on) | | ๐Ÿ’ญ | Considering (open to a maintainer picking it up) | > [!NOTE] > _A new forge needs an [adapter](src/renderer/utils/forges/) plus a designated maintainer. See [our contributing guide](CONTRIBUTING.md#multi-forge-support) for the full policy._ ## Quick Start 1. **Download** Gitify for free from [gitify.io][website]. 2. **Install** and launch the app for your platform. 3. **Authenticate** with one or many supported accounts and start receiving notifications. #### Homebrew macOS users can also install via [Homebrew][brew] ```shell brew install gitify ``` ## Build & Development To build and run Gitify locally: ```shell pnpm install pnpm build pnpm dev ``` See [CONTRIBUTING.md](CONTRIBUTING.md) for full development and contribution instructions. ## FAQ See our [Gitify FAQs][faqs] for answers to common questions. ## Community & Support - Open an [issue][github-issues] for bugs or feature requests - See [CONTRIBUTING.md](CONTRIBUTING.md) for more ways to get involved ## License Gitify is licensed under the MIT Open Source license. For more information, see [LICENSE](LICENSE). [website]: https://gitify.io [faqs]: https://gitify.io/faq [gitify-social]: https://raw.githubusercontent.com/gitify-app/website/master/public/images/social.png [github]: https://github.com/gitify-app/gitify [github-actions]: https://github.com/gitify-app/gitify/actions [github-issues]: https://github.com/gitify-app/gitify/issues [github-releases]: https://github.com/gitify-app/gitify/releases/latest [github-website]: https://github.com/gitify-app/website [github-website-pulls]: https://github.com/gitify-app/website/pulls [brew]: https://brew.sh/ [homebrew-cask]: https://formulae.brew.sh/cask/gitify [coverage-badge]: https://img.shields.io/sonar/coverage/gitify-app_gitify?server=https%3A%2F%2Fsonarcloud.io&logo=sonarqubecloud [coverage]: https://sonarcloud.io/summary/new_code?id=gitify-app_gitify [quality-badge]: https://img.shields.io/sonar/quality_gate/gitify-app_gitify?server=https%3A%2F%2Fsonarcloud.io&logo=sonarqubecloud [quality]: https://sonarcloud.io/summary/new_code?id=gitify-app_gitify [ci-workflow-badge]: https://img.shields.io/github/actions/workflow/status/gitify-app/gitify/ci.yml?logo=github&label=CI [release-workflow-badge]: https://img.shields.io/github/actions/workflow/status/gitify-app/gitify/release.yml?logo=github&label=Release [downloads-total-badge]: https://img.shields.io/github/downloads/gitify-app/gitify/total?label=downloads@all&logo=github [downloads-latest-badge]: https://img.shields.io/github/downloads/gitify-app/gitify/latest/total?logo=github [contributors-badge]: https://img.shields.io/github/contributors/gitify-app/gitify?logo=github [license]: LICENSE [license-badge]: https://img.shields.io/github/license/gitify-app/gitify?logo=github [github-release-badge]: https://img.shields.io/github/v/release/gitify-app/gitify?logo=github [homebrew-cask-badge]: https://img.shields.io/homebrew/cask/v/gitify?logo=homebrew&logoColor=white [renovate]: https://github.com/gitify-app/gitify/issues/576 [renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate&logoColor=white ## 2. Official Technical Reference & Guides (gitify-app/website) # gitify.io [![Netlify Status][netlify-badge]][netlify-deploys] [![Renovate enabled][renovate-badge]][renovate] [![Contributors][contributors-badge]][github] [![OSS License][license-badge]][license] > The source code for our gitify.io website > Made with Astro. ## ๐Ÿš€ Project Structure Inside of your Astro project, you'll see the following folders and files: ``` / โ”œโ”€โ”€ public/ โ”‚ โ””โ”€โ”€ favicon.svg โ”œโ”€โ”€ src/ โ”‚ โ”œโ”€โ”€ components/ โ”‚ โ”‚ โ””โ”€โ”€ Logo.astro โ”‚ โ”œโ”€โ”€ layouts/ โ”‚ โ”‚ โ””โ”€โ”€ Layout.astro โ”‚ โ””โ”€โ”€ pages/ โ”‚ โ””โ”€โ”€ index.astro โ””โ”€โ”€ package.json ``` Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. Any static assets, like images, can be placed in the `public/` directory. ## ๐Ÿงž Commands All commands are run from the root of the project, from a terminal: | Command | Action | | :------------------ | :------------------------------------------------- | | `pnpm install` | Installs dependencies | | `pnpm run dev` | Starts local dev server at `http://localhost:4321` | | `pnpm run build` | Build your production site to `./dist/` | | `pnpm run preview` | Preview your build locally, before deploying | | `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | | `pnpm astro --help` | Get help using the Astro CLI | [github]: https://github.com/gitify-app/website [contributors-badge]: https://img.shields.io/github/contributors/gitify-app/website?logo=github [netlify-badge]: https://img.shields.io/netlify/a060080d-e0bd-46bf-a2b5-0290a18ead9d?logo=netlify&logoColor=white [netlify-deploys]: https://app.netlify.com/projects/gitify/deploys [license]: LICENSE [license-badge]: https://img.shields.io/github/license/gitify-app/gitify?logo=github [renovate]: https://github.com/gitify-app/website/issues/15 [renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate&logoColor=white