README.md

FluentHub

The stylish yet powerful GitHub client for Windows.

---

Installation

Via Microsoft Store

This is the preferred installation method. It allows you to always be on the latest version when we release new builds via automatic updates.

Via GitHub

Released builds can be manually downloaded from this repository's releases page.

Download the FluentHub_<versionNumber>.msixbundle file from the Assets section. In order to install the app, you can simply double-click on the .msixbundle file, and the app installer should automatically run. If that fails for any reason, you can try the following command with a PowerShell prompt:

# NOTE: If you are using PowerShell 7+, please run
#   Import-Module Appx -UseWindowsPowerShell
# before using Add-AppxPackage.

Add-AppxPackage FluentHub_<versionNumber>.msixbundle

Building from source

See the build section.

Screenshots

Contributing

There are multiple ways to participate in the community:

• Submit bugs and feature requests.
• Review the documentation and make pull requests for anything from typos to additional and new idea
• Review source code changes

If you are interested in fixing issues and contributing directly to the code base, please refer to the documentation, which covers the following:

• How to build and run from source
• The development workflow, including debugging and running tests
• Coding guidelines
• Submitting pull requests
• Finding an issue to work on
• Contributing to translations on Crowdin

Codebase Structure

.
└──src                               // The source code.
   ├──FluentHub.App                  // Code for most front-end elements of the app.
   ├──FluentHub.Core                 // Core elements of the app.
   ├──FluentHub.Octokit              // Code for most back-end and API-related elements of the app such as mutations and queries.
   └──FluentHub.Octokit.Generation   // GitHub GraphQL API model generator.

Feedback

• Request a new feature
• Upvote popular feature requests
• File an issue
• Join our Discord and let us know what you think

Building the Code

1. Prerequisites

Ensure you have installed the following tools:

• Windows 10 2004 (10.0.19041.0) or later with Developer Mode on in the Windows Settings
• Git
• Visual Studio 2022 with following individual components:
  • Windows 11 (10.0.22000.0) SDK
  • Windows App SDK
  • .NET 7 SDK

2. Git

Clone the repository:

git clone https://github.com/FluentHub/FluentHub

3. Prepare OAuth credentials

See the documentation.

Warning: If you skip this step, Visual Studio will give a fatal error that the AppCredentials.config file does not exist.

4. Build the project

• Open FluentHub.sln.
• Hit 'Set as Startup item' on FluentHub.Package in the Solution Explorer.
• Build with DEBUG, x64, FluentHub.Package.

Credit

• Some application icons were created by Icons8.
• Many thanks to Joseph Beattie for creating our current logo.