feat(docs): update README.md with full project structure and CI/CD docs
All checks were successful
Deploy Flowstate to VPS / deploy (push) Successful in 56s
All checks were successful
Deploy Flowstate to VPS / deploy (push) Successful in 56s
This commit is contained in:
parent
8891c106a2
commit
37bfb0e759
1 changed files with 20 additions and 3 deletions
23
README.md
23
README.md
|
|
@ -2,20 +2,24 @@
|
|||
|
||||
A modern, high-performance Kanban & Workflow web application designed to help you lock in and enter the productivity flow.
|
||||
|
||||
[](https://git.andre-kempf.com/Chneemann/flowstate/actions)
|
||||
[](https://flowstate.andre-kempf.com)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
## 🛠️ Tech Stack
|
||||
|
||||
- **Framework:** [Next.js 16](https://nextjs.org/) (App Router, Route Groups)
|
||||
- **UI & Styling:** [React 19](https://react.dev/), [Tailwind CSS v4](https://tailwindcss.com/)
|
||||
- **Authentication:** [Auth.js v5 (NextAuth)](https://authjs.dev/) with Credentials Provider & bcrypt hashing
|
||||
- **Database & ORM:** [PostgreSQL](https://www.postgresql.org/) managed via [Drizzle ORM](https://orm.drizzle.team/) & Drizzle Kit
|
||||
- **Database & ORM:** [PostgreSQL](https://www.postgresql.org/) managed via [Drizzle ORM](https://orm.drizzle.team/) & Drizzle Kit (Studio included)
|
||||
- **DevOps & Infrastructure:** Docker & Docker Compose, Caddy Reverse Proxy, Forgejo Actions (CI/CD Automated Deployment)
|
||||
|
||||
## 📂 Architecture & Structure
|
||||
|
||||
|
|
@ -25,7 +29,20 @@ The project uses Next.js Route Groups to separate public and protected applicati
|
|||
- `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, and full authentication (Auth.js v5) are implemented.
|
||||
_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.
|
||||
|
|
|
|||
Loading…
Reference in a new issue