## Real‑Time Issue Board for Small Distributed Teams - Backend
**Track bugs, feature requests, and stand‑up items instantly.**
> "
> A lightweight, performant, and self‑hosted issue board that lets remote teams - track bugs, feature requests, and daily stand‑up items instantly with real‑time updates, flexible workflows, and full privacy & data ownership —no Jira, Trello, or Azure Boards required.
> Built with a Rust backend (high‑performance REST API + WebSocket sync) for instant board updates and a React frontend (responsive UI, drag‑and‑drop columns). The whole stack can be deployed with a single Docker‑Compose file, making it easy for any team to spin up on a VPS, a home server, or even a Raspberry Pi.
> "
---
### Table of Contents
1. [Why this project](#why-this-project)
2. [Features (MVP)](#features-mvp)
3. [Quick start](#Quick-start)
4. [License](#license)
---
### Why this project
- **Fast, real‑time collaboration** – WebSocket‑driven updates mean every teammate sees changes the moment they happen.
- **Self‑hosted & portable** – Deploy with a single docker‑compose.yml to any VPS, home server, or Raspberry Pi.
- **Customizable workflows** – Simple drag‑and‑drop columns, plus hooks for automation tailored to startups and hobby groups.
- **Zero overhead** – Minimal UI, no licensing fees, and no “status‑check” email chains.
---
### Features (MVP)
- Live board sync via WebSockets
- Drag‑and‑drop Kanban columns (React fork DND)
- Rich card data (markdown, assignee, labels, due date, attachments)
- OAuth2 login (GitHub) with role‑based permissions
- Activity log & optional webhook/email notifications
- One‑click Docker‑Compose deployment (Rust API, PostgreSQL, Nginx‑served React UI)
---
### Quick start
```bash
git clone https://github.com/sumanjangili/real-time-issue-board.git
cd real-time-issue-board
docker compose up -d # builds & starts db, backend, frontend
# Backend API: http://localhost:8000/api
# Frontend UI : http://localhost:3000
```
#### Backend Development
```bash
cd backend
cargo build && cargo run --release # server listening on http://localhost:8000
```
#### Run the backend stack locally on docker
```bash
docker compose build --no-cache backend
docker compose up -d backend # Test the container
```
---
### License
The backend is also released under the **MIT License** (see the repository‑wide LICENSE file).
#### Contributing
- Feel free to open pull requests, report bugs, or suggest enhancements via the GitHub Issues page.
- For larger feature work, consider creating a feature branch and linking the PR to the corresponding issue.
---