Skip to content

docs: update README introduction and add Tech Highlights section #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coolert merged 1 commit into from
Dec 7, 2025
Merged

docs: update README introduction and add Tech Highlights section #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
![CI](https://github.com/coolert/task-manager/actions/workflows/ci.yml/badge.svg)
![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)

A production-grade **Laravel 12 backend** showcasing clean architecture, strict typing,
fully tested APIs, and modern engineering practices.

Includes JWT auth (Redis blacklist), policy-based RBAC, DTOs + Services,
OpenAPI 3.1 documentation, RabbitMQ message pipeline, and a complete CI workflow.
A collaborative task & project management backend built with Laravel 12,
featuring clean architecture, strict typing, full test coverage, and modern
engineering practices such as CI/CD automation, RabbitMQ-based messaging,
and a robust RBAC authentication system.

---

Expand All @@ -28,6 +27,19 @@ OpenAPI 3.1 documentation, RabbitMQ message pipeline, and a complete CI workflow

---

## ⭐ Tech Highlights

- Clean architecture with DTO + Service layer
- Policy-based RBAC with scoped model binding
- Fully tested APIs using Pest (parallel)
- Production-grade message pipeline (Outbox → Retry → Inbox → DLQ)
- Deployment automation with GitHub Actions + SSH
- Supervisor-managed queue workers
- Redis-backed JWT blacklist for secure logout
- OpenAPI 3.1 documentation with automated validation

---

## ⚙️ Setup & Quick Start

```bash
Expand Down Expand Up @@ -181,10 +193,10 @@ The project includes a lightweight production deployment workflow:
- Manual deployment trigger via GitHub Actions
- Secure SSH deployment to the server
- Server executes a deploy.sh script:
- Pull latest code
- Install optimized Composer dependencies
- Run database migrations
- Rebuild application caches
- Pull latest code
- Install optimized Composer dependencies
- Run database migrations
- Rebuild application caches
- Supervisor manages long-running workers (mq:work)
- Cron (run as www-data) triggers Laravel’s scheduler every minute

Expand Down