flowstate/README.md
Chneemann 37bfb0e759
All checks were successful
Deploy Flowstate to VPS / deploy (push) Successful in 56s
feat(docs): update README.md with full project structure and CI/CD docs
2026-08-15 12:22:50 +02:00

3.3 KiB

Flowstate

A modern, high-performance Kanban & Workflow web application designed to help you lock in and enter the productivity flow.

Deployment Status Website Status Next.js React TypeScript Tailwind CSS Auth.js Drizzle ORM PostgreSQL Docker Compose

🛠️ Tech Stack

📂 Architecture & Structure

The project uses Next.js Route Groups to separate public and protected application areas cleanly:

  • app/(auth)/ — Public authentication routes (Login, Register)
  • app/(app)/ — Protected workspace & dashboard routes (Sidebar, Header, Kanban Board)
  • app/api/ — Backend API endpoints & Auth handlers (/api/auth/register, [...nextauth])
  • db/ — Database schema definitions, migrations, and Drizzle configuration (drizzle.config.ts)
  • services/ — Business logic layers and external API integration services
  • utils/ — Shared helper functions, formatters, and global utility logic
  • types/ — Global TypeScript interfaces and type definitions
  • public/ — Static assets (images, icons, fonts)
  • .forgejo/workflows/ — Automated SSH deployment pipeline (deploy.yml)

🚀 CI/CD & Deployment

Deployments are fully automated using Forgejo Actions and SSH:

  1. Automated Trigger: Pushes to the main branch trigger the SSH deployment workflow.
  2. Database Schema Sync: Migrations are applied in milliseconds using drizzle-kit push executed directly inside the active flowstate-studio container.
  3. Zero-Downtime Container Rebuild: Rebuilds production Docker images (flowstate) without disrupting live database volumes.

🎯 Current Status

In Progress — Core layout structure, responsive navigation, PostgreSQL database integration via Drizzle ORM, full authentication (Auth.js v5), and an automated production CI/CD deployment pipeline are fully operational.