Files
LazyPM/README.md
2026-02-02 12:25:43 +01:00

84 lines
1.6 KiB
Markdown

# LazyPM
A project management tool for developers.
Made for bachelor project, used for gathering and comparing data between interfaces.
## Overview
LazyPM is a lightweight project management system that provides three interfaces:
- **CLI** - Command-line interface for quick operations
- **TUI** - Terminal user interface for interactive use
- **Web** - Browser-based interface with HTML templates
## Features
- Issue tracking (bugs, features, tasks, epics, chores)
- Status management (open, in-progress, blocked, deferred, closed)
- Dependency tracking between issues
- Labels and comments
- Statistics and reporting
- SQLite storage via Beads library
## Quick Start
```bash
# Install dependencies
go mod tidy
```
### Install make
Linux:
```bash
sudo pacman -S make
```
Windows (Choco):
```bash
# Install choco
winget install --id chocolatey.chocolatey --source winget
# Install make
choco install make
```
### Available make commands
```bash
# Build all interfaces
make build
# Run CLI
make cli
# Run TUI
make tui
# Run Web interface
make web
# Development with hot reload
make dev
```
## Project Structure
```
├── cmd/ # Entry points (cli, tui, web)
├── internal/ # Core services and models
├── pkg/ # Public packages (CLI, TUI, Web)
└── .pm/ # Local data storage
```
## Requirements
- Go 1.25.6+
- SQLite
## Dependencies
- [Cobra](https://github.com/spf13/cobra) - CLI framework
- [templ](https://github.com/a-h/templ) - HTML templating
- [beads](https://github.com/steveyegge/beads) - Issue tracking engine