11# github_pm
2+
23A tool to help with project management using GitHub issues, PRs, milestones, labels
34
45## Overview
@@ -7,7 +8,7 @@ A tool to help with project management using GitHub issues, PRs, milestones, lab
78
89This project provides a backend API (FastAPI) and a frontend web UI for seamless and organized project management, all with modern best practices.
910
10- ---
11+ ______________________________________________________________________
1112
1213## Features
1314
@@ -17,7 +18,7 @@ This project provides a backend API (FastAPI) and a frontend web UI for seamless
1718- Easy-to-use web interface (frontend)
1819- Powerful RESTful API (backend)
1920
20- ---
21+ ______________________________________________________________________
2122
2223## Getting Started
2324
@@ -72,7 +73,7 @@ and then you can terminate with 'kill-pm'
7273 alias kill-pm="kill -- - 49613"
7374```
7475
75- ---
76+ ______________________________________________________________________
7677
7778## Usage
7879
@@ -102,25 +103,25 @@ select and reorder from the "Sort" pulldown at the top of the page. For example,
102103you can show "bugs" first, or "high priority" followed by "medium priority"
103104followed by "low priority".
104105
105- ---
106+ ______________________________________________________________________
106107
107108## Development
108109
109110### Linting & Formatting
110111
111- - ** Backend:**
112+ - ** Backend:**
112113 - Lint: ` uv run flake8 src tests `
113114 - Format: ` uv run black --check src tests `
114115 - Import Sort: ` uv run isort --check src tests `
115- - ** Frontend:**
116+ - ** Frontend:**
116117 - Format: ` npm run format:check `
117118 - Lint: (add your preferred lint command)
118119
119120### Testing
120121
121- - ** Backend:**
122+ - ** Backend:**
122123 - Run tests (add your test framework/command here)
123- - ** Frontend:**
124+ - ** Frontend:**
124125 - Run tests: ` npm test -- --run `
125126
126127### Continuous Integration
@@ -130,31 +131,30 @@ GitHub Actions are set up for linting, formatting, and testing on pull requests
130131- Backend: Python linting, formatting, dependency install via [ uv] ( https://github.com/astral-sh/uv )
131132- Frontend: Node linting, formatting, and tests
132133
133- ---
134+ ______________________________________________________________________
134135
135136## Configuration
136137
137138- Edit your backend configuration and package dependencies in ` backend/pyproject.toml `
138139- Customize Flake8 with ` .flake8 ` in the backend directory
139140
140- ---
141+ ______________________________________________________________________
141142
142143## Contributing
143144
144- Issues and pull requests are welcome!
145+ Issues and pull requests are welcome!
145146See [ CONTRIBUTING.md] ( CONTRIBUTING.md ) (if available) or open an issue for any questions or suggestions.
146147
147- ---
148+ ______________________________________________________________________
148149
149150## License
150151
151152[ Apache License 2.0] ( LICENSE )
152153
153- ---
154+ ______________________________________________________________________
154155
155156## Links
156157
157158- ** Homepage & Docs:** [ https://github.com/dbutenhof/github-pm ] ( https://github.com/dbutenhof/github-pm )
158159- ** Repository:** [ https://github.com/dbutenhof/github-pm ] ( https://github.com/dbutenhof/github-pm )
159160- ** Report Issues:** [ https://github.com/dbutenhof/github-pm/issues ] ( https://github.com/dbutenhof/github-pm/issues )
160-
0 commit comments