Skip to content

Update README#19

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
NFAsylum merged 3 commits into from
May 1, 2026
Merged

Update README #19

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7c1c35
Update README
NFAsylum May 1, 2026
4d5ac17
Merge branch 'marco' of https://github.com/NFAsylum/TaskFlow into marco
NFAsylum May 1, 2026
070e968
Merge branch 'main' of https://github.com/NFAsylum/TaskFlow into marco
NFAsylum May 1, 2026
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
37 changes: 33 additions & 4 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,14 +2,18 @@

TaskFlow is a Kanban board for task management via tickets. TaskFlow enables fast and simple task management with drag-and-drop and edit in-place of tickets.

[Live Demo](https://taskflow-frontend-t4ww.onrender.com/) - first request may take ~1 min (free-tier auto-stop)

## Stack

**Frontend:** React 19, TypeScript, Tailwind CSS, React Router, @dnd-kit

**Backend:** ASP.NET Core (.NET 9), Entity Framework Core, SQLite
**Backend:** ASP.NET Core (.NET 9), Entity Framework Core, Postgres

**Auth:** JWT + BCrypt

**Infrastructure:** Docker, nginx, GitHub Actions CI, Render (deploy)

## Screenshots

### Light mode
Expand All@@ -20,9 +24,19 @@ TaskFlow is a Kanban board for task management via tickets. TaskFlow enables fas

![TaskFlow Dark](screenshot-dark.png)

## Setup
## Quick start

### With Docker

```bash
docker compose up --build
```

The app runs at http://localhost (frontend) with the API at http://localhost:8080

### Without Docker

### Backend
Backend:

```bash
cd TaskFlow.Api
Expand All@@ -31,7 +45,7 @@ dotnet ef database update
dotnet run -- --auto-create-jwt true
```

### Frontend
Frontend:

```bash
cd taskflow-frontend
Expand All@@ -40,3 +54,18 @@ npm run dev
```

The app runs at http://localhost:5173 with the API at http://localhost:5278

## Decisions

- Postgres over SQLite: same database in development and production (dev/prod parity). SQLite doesn't survive container restarts without volume hacks;
- JWT over cookies: simpler implementation for a SPA, token stored in localStorage;
- nginx as reverse proxy: serves static frontend files and proxies /api to the backend, avoiding CORS in Docker;
- Multi-stage Docker builds: final images contain only runtime dependencies.

## What I'd do differently at scale

- Refresh token rotation (current JWT has no expiration strategy)
- Rate limiting on auth endpoints
- Redis cache layer for frequently read tickets
- Connection pooling with PgBouncer
- E2E tests with Playwright
Loading