Skip to content

README.md

Latest commit

 

History

History
151 lines (112 loc) · 6.81 KB

README.md

File metadata and controls

151 lines (112 loc) · 6.81 KB
Raw

TaskFlow

A web app that helps students and small teams organize their projects and manage tasks in one place.

Team 6

Member GitHub
Diego Artemio Garcia @NomadicAlternative
Joshua Abinadi Cirilo @joshuacirilo
Nelson Mandella Akpomah @mandellasly1
Taiye Gabriel Ade-Benson @adebenson20

Synchronous meeting: Wednesdays at 22:00 UTC.

Tech stack

Layer Technology
Framework Next.js (App Router)
Language TypeScript (strict mode)
Styling Tailwind CSS
Database PostgreSQL on Supabase
Data access Prisma
Authentication Auth.js v5 (credentials)
Linting and formatting ESLint + Prettier
Deployment Vercel

Getting started

The project uses pnpm.

git clone <repository-url>
cd taskflow
pnpm install

Create a .env file in the project root (it is ignored by Git):

DATABASE_URL="postgresql://postgres.<project-ref>:<url-encoded-password>@aws-0-us-east-2.pooler.supabase.com:5432/postgres"
AUTH_SECRET="<output of: npx auth secret>"
# Only needed to run `pnpm start` locally; dev mode and Vercel trust the host automatically.
AUTH_TRUST_HOST=true

Use the Supabase session pooler URL: the direct db.<project-ref>.supabase.co host is IPv6-only. Then apply the migrations and start the app:

pnpm exec prisma migrate dev
pnpm dev

Open http://localhost:3000.

Command What it does
pnpm dev Development server
pnpm build Production build
pnpm lint ESLint
pnpm format Formats the code with Prettier
pnpm format:check Checks formatting without changing files

Graphify (local code graph)

Graphify is an optional development tool. Its official Python package is graphifyy; it is separate from the app's npm dependencies.

Set up the project-local environment with uv in PowerShell:

uv venv .graphify-venv --python 3.12
uv pip install --python .graphify-venv/Scripts/python.exe graphifyy==0.9.71
.\.graphify-venv\Scripts\graphify.exe install --project --platform agents

Build or refresh the code graph locally, without an API key:

.\.graphify-venv\Scripts\graphify.exe extract . --code-only --max-workers 2
.\.graphify-venv\Scripts\graphify.exe cluster-only . --no-label
.\.graphify-venv\Scripts\graphify.exe query "RootLayout"
Start-Process .\graphify-out\graph.html

The generated graph, report, Python environment, and local assistant skill are ignored by Git and Prettier. --code-only skips semantic analysis of documents and media. The skill is installed under .agents/skills/graphify/ for Codex; invoke it with $graphify in a new turn and use the project-local executable above. Terminal commands use graphify, without a leading slash.

Branching

main is protected. Nobody pushes to it directly.

  1. Branch off main using feature/<short-description>, for example feature/user-auth.
  2. Commit your work on that branch.
  3. Open a pull request into main.
  4. At least one other team member must review and approve it.
  5. Merge only after the review.

Keep pull requests small and focused on one thing. A pull request that does five things is a pull request nobody reviews properly.

Code standards

  • Formatting is handled by Prettier. The rules live in .prettierrc and are shared by the whole team, so nobody argues about style in a review. Run pnpm format before committing.
  • Correctness is handled by ESLint. eslint-config-prettier is applied last so the linter does not report formatting issues.
  • Commits follow Conventional Commits: feat:, fix:, docs:, chore:, refactor:.
  • TypeScript runs in strict mode and any is not allowed. Types are explicit on component props.

Project structure

taskflow/
├── app/          Routes, layouts and API route handlers
├── components/   Reusable UI components
├── lib/          Types, data access and shared helpers
└── public/       Static assets

API

All routes require a signed-in session and return 401 otherwise. Mutations return 400 for invalid input and 404 when the record is missing or belongs to another user (owner-scoped).

Method Route Description
GET /api/projects List the signed-in user's projects
POST /api/projects Create a project
GET /api/projects/:id Get one project (owner-scoped)
PATCH /api/projects/:id Update a project
DELETE /api/projects/:id Delete a project
GET /api/projects/:id/tasks List a project's tasks
POST /api/projects/:id/tasks Create a task in a project
PATCH /api/tasks/:id Update a task (title/description/status)
DELETE /api/tasks/:id Delete a task

Specification

The project specification lives in specs/. Read it before starting a feature — it is the source of truth for what we are building and what is out of scope.

Coordination

Beyond the weekly meeting, keep the team posted asynchronously in our Microsoft Teams channel: what you finished, what you are working on next, and anything blocking you.

Known issues & opportunities

  • Owner-only model: every project and task belongs to a single user; there is no multi-user sharing or collaboration yet (tracked in issue #3).
  • No Open Graph image: there is no committed brand asset yet, so shared links render the title/description without a preview image.
  • No password reset: credentials auth has no recovery flow yet.
  • No loading/error boundaries on the project detail page for database outages (the API routes handle their own errors, but the page does not).