🧠 Flowee - Project Management Platform

Flowee is a SaaS application built to streamline project management between companies and their clients. By centralizing communications and tracking deliverables, Flowee enhances visibility, organization, and accountability across all stages of a project.

---

🌍 Overview

Flowee provides a secure and adaptive platform that includes:

• 🧾 Client profile management
• 📁 Project and deliverable tracking
• ✅ Task assignment and status updates
• 📊 Role-based dashboards
• 🔐 Built-in authentication and access control

---

💡 Tech Stack

Backend

• Node.js
• TypeORM
• TypeGraphQL
• Apollo Server
• PostgreSQL

Frontend

• React
• Apollo Client
• Tailwind CSS
• TypeScript

---

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/yourusername/flowee.git
cd flowee

2. Environment Configuration

cp .env.example .env

Edit the .env file to match your database/user/port config.

3. First Launch (Development)

make first-launch

---

🐳 Docker & Makefile

Start Containers

make run

Stop Containers

make stop

Restart Containers

make restart

---

💾 PostgreSQL Management

🗃️ Roles

Role	Username	Purpose	Created via
Superadmin	postgres	Create roles and databases	init_db_user.ts
Application user	flowee_user	Used by app & TypeORM for operations	dataSource.ts

🔧 Initialize DB

make init-db-user

Executes:

• User & DB creation
• Full privileges on schema, tables, sequences

Run this when:

• .env changes (DB_USER / DB_NAME)
• You reset your DB container

🧼 Cleanup Test DB/User

make clean-test-users

🔄 Reset DB Schema

make reset-db

---

🔁 TypeORM Migrations

Generate a migration

make migration-generate

Apply migrations

make migrations

Revert last migration

make migration-revert

Create empty migration

make migration-create

---

🌱 Seed Data

make seed

Seeds initial records like an admin account.

---

🧪 Dev Tools

Access backend shell

make bash

View container logs

make logs

Check if backend is running

make check-backend

Display DB user

make whoami

---

🗂️ Project Structure

backend/
  └── src/
       ├── entities/       # TypeORM Entities
       ├── migration/      # SQL Migrations
       ├── scripts/        # DB init, seed, cleanup
       └── dataSource/     # TypeORM config
frontend/
  └── ...                  # React app

---

🏗️ Architecture

Flowee follows a modern 3-tier architecture:

1. Presentation Layer (Frontend)

• React + Tailwind
• Atomic Design (Atoms, Molecules, Organisms)
• Apollo Client for state & GraphQL

2. Business Logic Layer (Backend)

• Apollo Server + TypeGraphQL
• Authorization, resolvers, and input validation

3. Persistence Layer (Database)

• PostgreSQL
• TypeORM (entities, migrations, relations)

---

🔄 CI / CD

Flowee uses GitHub Actions for CI/CD workflows:

✅ Automated Tests

• Unit (Jest)
• Integration (API <-> Frontend)
• Linting + TypeScript validation

🚀 Deployment Pipeline

• dev: auto deploy on every push
• staging: auto deploy on PR merge
• main: validated production deployment

---

📜 License

MIT

---

❤️ About

Flowee was created to help freelancers and small businesses better collaborate with clients. Its goal is to make project communication structured, traceable, and simple.