An open API service indexing awesome lists of open source software.

https://github.com/liubinfighter/github-projects

Manage and view GitHub Issues and Projects directly within workspace. Jump to your ide. Gain insights from workbench in the main view.
https://github.com/liubinfighter/github-projects

github issue-tracker obsidian obsidian-plugin

Last synced: 2 months ago
JSON representation

Manage and view GitHub Issues and Projects directly within workspace. Jump to your ide. Gain insights from workbench in the main view.

Awesome Lists containing this project

README

          

# Obsidian GitHub Projects

Manage and view GitHub Issues and Projects directly within workspace. Jump to your ide. Gain insights from workbench in the main view.

![v0.1.0](./assets/v0.1.0.png)

## Roadmap

| **Module / Feature** | **Pull**
*View & Fetch* | **Jump**
*Navigate* | **Push**
*Create/Edit* | **Link**
*Note Integration* |
|:--------------------:|:-------------------------:|:----------------------:|:-------------------------:|:------------------------------:|
| **UI / UX & Core** | πŸš€ **Dashboard Workbench**
πŸš€ **Modern Card Layout** | πŸš€ **Tab Navigation**
βœ… **Unified Header Bar** | πŸš§πŸ€” **Theme/Appearance Customization**
πŸš§πŸ€” Drag & Drop | - |
| **Issues** | βœ… Fetch & View Issues
βœ… Filter, Expand, Sync
πŸš€ Cross-repo Stats | βœ… Jump to GitHub Issue
πŸš€ **Open Repo in IDE via Command** | 🚧 Create New Issue
🚧 Comment, Close, Edit Issue
🚧 (vscode-like developer experience) | πŸš€ **Create Note from Issue (button exists)**
πŸš§πŸ€”Link Existing Note |
| **Projects** | πŸš€πŸ€” **Fetch & View Projects (Repo/Org/User)** | πŸš€ **Jump to GitHub Project Board** | 🚧 Create/Edit Project Item
🚧 Move Project Item State | πŸš§πŸ€” Link Project to Note |
| **Workbench** | πŸš€ Multi-repo/Project Aggregation
πŸš€πŸ€” Global Stats | πŸš€ Quick Nav to Settings | πŸš§πŸ€” Custom Workbench Layout | πŸš§πŸ€” Embed Stats Block in Note (like `wakatime` or `dataview.js`) |
| **Settings Tab** | βœ…Repo Config
βœ…Token Testing
πŸš€ Projects Management | πŸš€ Project/IDE Command Config | - | - |

**Legend:** βœ… = Completedβ€ƒπŸš€ = In-Dev/Betaβ€ƒπŸš§ = Plannedβ€ƒπŸ€” = Idea Wanted

> For developers, you can checkout branch `dev` to get a clear view of development. View issues for ideas and discussions!

## Getting Started

1. Install the plugin from the Obsidian Community Plugins store.
2. Go to `Settings` -> `Community Plugins` and enable "GitHub Projects".
3. Open the plugin settings (`Settings` -> `GitHub Projects`).
4. **Token Setup**: Navigate to the "Token Setup" tab. Create a new GitHub Personal Access Token with the `repo` scope (for private repositories) or `public_repo` (for public repositories only). Paste it into the input field and click "Test Token" to verify it.
5. **Add Repositories**: Switch to the "Repositories" tab. Add the GitHub repositories you want to manage by providing their URL or manually entering the owner and repository name.
6. **Configure Sync (Optional)**: In the "Sync Options" tab, you can enable automatic synchronization and set the interval.
7. **Start Managing**: Click the GitHub icon in the ribbon or use the "GitHub Projects: Open Issues View" command to open the issues panel and start managing your projects!

## Features

- **Effortless Setup**: A guided settings tab for your GitHub Token, repositories, and sync options, including a token validation feature.
- **Focused Issues View**: A dedicated sidebar to browse your GitHub Issues with powerful filtering (title, state, labels, etc.) and a one-click refresh.
- **Quick Access**: Open the view from the sidebar ribbon or a command palette command.
- **Smart Sync**: Automatic and manual synchronization with related commit counts for some issues.

## Design Philosophy

This plugin is built on a few core principles:

- **Remote-First**: GitHub is the single source of truth. This plugin provides a powerful, enhanced window into that truth, not a local mirror.
- **Local Enhancement**: We focus on connecting your project management to your knowledge base. The goal is to make Obsidian the ultimate starting point for your development workflow.
- **Focused Actions**: The plugin helps you view issues, link them to your notes, and transform them into new notes. It does not perform two-way synchronization of Markdown content between GitHub and Obsidian.

Additionally, I want to experience similar to that in this extension [vscode-pull-request-github](https://github.com/microsoft/vscode-pull-request-github).

## Vision

To seamlessly bridge the gap between ideation and execution. We believe that a great idea captured in Obsidian should effortlessly transition into a trackable task in your development workflow. This plugin aims to make Obsidian the most efficient and intuitive entry point for any issue-driven development style.

## Inspired By

- [Githobs](https://github.com/GabAlpha/obsidian-githobs)
- [vscode-pull-request-github](https://github.com/microsoft/vscode-pull-request-github)

## License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0). See the [LICENSE](./LICENSE) file for details.