Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌿 GitBar (for Mac)

A lightweight macOS menu bar app for monitoring your GitHub profile, contributions, and repositories.

GitBar Demo

GitHub Profile • Contributions • Repository Management


🚀 Features

  • Real-time Profile Overview: Instantly view your GitHub profile and today's commit count from the menu bar.
  • Repository Management: Access and manage your repositories directly from the menu bar.
  • Lightweight Design: Uses minimal system resources for efficient performance.
  • Simple & Intuitive UI: Just sign in with your GitHub account—no complicated setup required.

🚀 Getting Started

To build this project and connect it to the GitHub API, you must first create a GitHub App in your GitHub Developer Settings.

1. Create a GitHub App

  1. Go to GitHub Developer Settings.

  2. Click GitHub Apps.

  3. Click New GitHub App.

  4. Fill in the application information.

    • GitHub App name: AlwaysGitBar (or any name you prefer)
    • Homepage URL: http://github.com/{Username} (This project does not use the homepage URL. You can temporarily use your GitHub profile URL.)
    • Callback URL: showGit://login
  5. Click Create GitHub App to finish.

2. Obtain the Client ID and Client Secret

  1. Open the newly created GitHub App's details page.
  2. Copy the Client ID.
  3. Click Generate a new client secret to create a Client Secret.

Important: The Client Secret is displayed only once immediately after it is generated. Be sure to save it somewhere secure.

3. Clone the Project

Open Terminal and run:

git clone https://github.com/Seojun1/GitBar.git

4. Open the Project

Open AlwaysGitBar.xcodeproj in Xcode.

5. Create the Config File

In the Xcode file navigator, locate:

Always_GitBar/Config.sample.plist

Rename it:

Config.sample.plist
        ↓
Config.plist

6. Configure GitHub API Credentials

Select Config.plist, then enter the following values in the Property List editor.

Key Value
GITHUB_CLIENT_ID Paste your Client ID
GITHUB_CLIENT_SECRET Paste your Client Secret

Note

Config.plist is included in .gitignore, so it is not tracked by Git. Your GitHub Client ID and Client Secret will not be uploaded to your remote GitHub repository.

💡 Usage

  1. Launch the application.
  2. Click the GitBar icon in the macOS menu bar.
  3. Sign in with your GitHub account.
  4. Start managing your GitHub profile and repositories.

🛠 Tech Stack

Swift SwiftUI MVVM GitHub API

🤝 Contributing

Contributions are always welcome!

  1. Before submitting a Pull Request, please open an Issue describing your proposed changes.
  2. Fork this repository.
  3. Create a new branch.
git checkout -b feature/your-feature
  1. Commit your changes.
git commit -m "Add some AmazingFeature"
  1. Push your branch.
git push origin feature/AmazingFeature
  1. Open a Pull Request.

⚖️ License

This project is licensed under the MIT License.

See the LICENSE file for more details.

📧 Contact

Feel free to open an Issue in this repository or contact me at:

iseojun24@kookmin.ac.kr

About

A lightweight macOS menu bar app for monitoring your GitHub profile, contributions, and repositories.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages