# rahulad12/writespace architecture

> Architecture diagram of the GitHub repository rahulad12/writespace, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rahulad12/writespace
- Repository: https://github.com/rahulad12/writespace

## Overview

Writespace is a collaborative writing and discussion app: users register or log in, then access protected client pages and backend features for blogs, profiles, bookmarks, and follows. The documented posts and comments capabilities are represented, but their implementation appears incomplete or unsampled in the tree. The backend uses route/controller/service layers and PostgreSQL; the sampled authentication controller accesses the database directly. Some cross-module and post/comment relationships are documented or implied but not verified in excerpts, so those edges are dashed.

Main entry points: [`server/src/app.ts`](https://github.com/rahulad12/writespace/blob/master/server/src/app.ts) (API app), [`server/src/config/db.ts`](https://github.com/rahulad12/writespace/blob/master/server/src/config/db.ts) (PostgreSQL pool), [`server/src/modules/user/user.routes.ts`](https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.routes.ts) (User routes), [`client/src/App.tsx`](https://github.com/rahulad12/writespace/blob/master/client/src/App.tsx) (Client router)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["React client"]
  node_app["Client router<br/>[App.tsx]"]
  node_authpage["Auth pages<br/>[page.tsx]"]
  node_loginform["Login form<br/>[LoginForm.tsx]"]
  node_registerform["Register form<br/>[RegisterForm.tsx]"]
  node_formhook["Form state<br/>[useAuthForm.ts]"]
  node_authservice["Auth API calls<br/>[auth.service.ts]"]
  node_authstate["Auth state<br/>[useAuth.ts]"]
  node_api["HTTP client<br/>[apiClient.ts]"]
  node_protected["Route guard<br/>[ProtectedRoute.tsx]"]
  node_home["Home page<br/>[page.tsx]"]
end

subgraph group_server["Express API"]
  node_apiapp["API app<br/>[app.ts]"]
  node_authroutes["Auth routes<br/>[auth.routes.ts]"]
  node_authcontroller["Auth controller<br/>[auth.controller.ts]"]
  node_authmw["JWT middleware<br/>[auth.middleware.ts]"]
  node_validator["Request validator<br/>[validator.ts]"]
  node_db["PostgreSQL pool<br/>[db.ts]"]
end

subgraph group_content["Writing features"]
  node_blogroutes["Blog routes<br/>[blog.routes.ts]"]
  node_blogcontroller["Blog controller<br/>[blog.controller.ts]"]
  node_blogservice["Blog service<br/>[blog.service.ts]"]
  node_bookmarkroutes["Bookmark routes<br/>[bookmark.routes.ts]"]
  node_bookmarkcontroller["Bookmark controller"]
  node_bookmarkservice["Bookmark service"]
  node_post["Posts capability"]
  node_comments["Comments capability"]
end

subgraph group_social["Profiles and social"]
  node_userroutes["User routes<br/>[user.routes.ts]"]
  node_usercontroller["User controller<br/>[user.controller.ts]"]
  node_userservice["User service<br/>[user.service.ts]"]
  node_followroutes["Follow routes<br/>[follow.routes.ts]"]
  node_followcontroller["Follow controller"]
  node_followservice["Follow service<br/>[follow.service.ts]"]
end

node_user(("User"))
node_postgres[("PostgreSQL")]

node_user -->|"uses"| node_app
node_app -->|"routes to"| node_authpage
node_app -->|"routes to"| node_home
node_app -->|"guards profile"| node_protected
node_authpage -->|"renders"| node_loginform
node_authpage -->|"renders"| node_registerform
node_loginform -->|"uses"| node_formhook
node_registerform -->|"uses"| node_formhook
node_loginform -->|"calls"| node_authservice
node_registerform -->|"calls"| node_authservice
node_loginform -->|"updates"| node_authstate
node_registerform -->|"updates"| node_authstate
node_authservice -->|"sends requests"| node_api
node_protected -->|"checks"| node_authstate
node_home -->|"reads"| node_authstate
node_authservice -.->|"calls auth and user endpoints"| node_apiapp
node_apiapp -->|"mounts"| node_authroutes
node_apiapp -->|"mounts"| node_blogroutes
node_apiapp -->|"mounts"| node_bookmarkroutes
node_apiapp -->|"mounts"| node_userroutes
node_authroutes -->|"dispatches"| node_authcontroller
node_authroutes -->|"validates with"| node_validator
node_authcontroller -->|"queries"| node_db
node_db -.->|"connects"| node_postgres
node_blogroutes -->|"dispatches"| node_blogcontroller
node_blogroutes -->|"protects routes"| node_authmw
node_blogroutes -->|"validates with"| node_validator
node_blogcontroller -->|"calls"| node_blogservice
node_blogservice -->|"queries"| node_db
node_bookmarkroutes -->|"dispatches"| node_bookmarkcontroller
node_bookmarkroutes -->|"protects routes"| node_authmw
node_bookmarkcontroller -->|"calls"| node_bookmarkservice
node_bookmarkservice -->|"queries"| node_db
node_apiapp -.->|"may expose"| node_post
node_apiapp -.->|"may expose"| node_comments
node_userroutes -->|"dispatches"| node_usercontroller
node_userroutes -->|"dispatches profile follow queries"| node_followcontroller
node_userroutes -->|"protects routes"| node_authmw
node_userroutes -->|"validates with"| node_validator
node_usercontroller -->|"calls"| node_userservice
node_userservice -->|"queries"| node_db
node_followroutes -->|"dispatches"| node_followcontroller
node_followroutes -->|"protects routes"| node_authmw
node_followcontroller -->|"calls"| node_followservice
node_followservice -->|"queries"| node_db

click node_app "https://github.com/rahulad12/writespace/blob/master/client/src/App.tsx"
click node_authpage "https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/page.tsx"
click node_loginform "https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/components/LoginForm.tsx"
click node_registerform "https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/components/RegisterForm.tsx"
click node_formhook "https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/hooks/useAuthForm.ts"
click node_authservice "https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/services/auth.service.ts"
click node_authstate "https://github.com/rahulad12/writespace/blob/master/client/src/shared/hooks/useAuth.ts"
click node_api "https://github.com/rahulad12/writespace/blob/master/client/src/shared/config/apiClient.ts"
click node_protected "https://github.com/rahulad12/writespace/blob/master/client/src/shared/components/ProtectedRoute.tsx"
click node_home "https://github.com/rahulad12/writespace/blob/master/client/src/modules/home/page.tsx"
click node_apiapp "https://github.com/rahulad12/writespace/blob/master/server/src/app.ts"
click node_authroutes "https://github.com/rahulad12/writespace/blob/master/server/src/modules/auth/auth.routes.ts"
click node_authcontroller "https://github.com/rahulad12/writespace/blob/master/server/src/modules/auth/auth.controller.ts"
click node_authmw "https://github.com/rahulad12/writespace/blob/master/server/src/shared/middleware/auth.middleware.ts"
click node_validator "https://github.com/rahulad12/writespace/blob/master/server/src/shared/middleware/validator.ts"
click node_db "https://github.com/rahulad12/writespace/blob/master/server/src/config/db.ts"
click node_blogroutes "https://github.com/rahulad12/writespace/blob/master/server/src/modules/blog/blog.routes.ts"
click node_blogcontroller "https://github.com/rahulad12/writespace/blob/master/server/src/modules/blog/blog.controller.ts"
click node_blogservice "https://github.com/rahulad12/writespace/blob/master/server/src/modules/blog/blog.service.ts"
click node_bookmarkroutes "https://github.com/rahulad12/writespace/blob/master/server/src/modules/bookmark/bookmark.routes.ts"
click node_bookmarkcontroller "https://github.com/rahulad12/writespace/blob/master/server/src/modules/bookmark/bookmark.controller.ts"
click node_bookmarkservice "https://github.com/rahulad12/writespace/blob/master/server/src/modules/bookmark/bookmark.service.ts"
click node_post "https://github.com/rahulad12/writespace/tree/master/server/src/modules/post"
click node_comments "https://github.com/rahulad12/writespace/tree/master/server/src/modules/comment"
click node_userroutes "https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.routes.ts"
click node_usercontroller "https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.controller.ts"
click node_userservice "https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.service.ts"
click node_followroutes "https://github.com/rahulad12/writespace/blob/master/server/src/modules/follow/follow.routes.ts"
click node_followcontroller "https://github.com/rahulad12/writespace/blob/master/server/src/modules/follow/follow.controller.ts"
click node_followservice "https://github.com/rahulad12/writespace/blob/master/server/src/modules/follow/follow.service.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_authpage,node_loginform,node_registerform,node_formhook,node_authservice,node_authstate,node_api,node_protected,node_home,node_user toneBlue
class node_apiapp,node_authroutes,node_authcontroller,node_authmw,node_validator,node_db,node_postgres toneAmber
class node_blogroutes,node_blogcontroller,node_blogservice,node_bookmarkroutes,node_bookmarkcontroller,node_bookmarkservice,node_post,node_comments toneMint
class node_userroutes,node_usercontroller,node_userservice,node_followroutes,node_followcontroller,node_followservice toneRose
```

## Components

### React client

- [Client router](https://github.com/rahulad12/writespace/blob/master/client/src/App.tsx): `client/src/App.tsx`
- [Auth pages](https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/page.tsx): `client/src/modules/auth/page.tsx`
- [Login form](https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/components/LoginForm.tsx): `client/src/modules/auth/components/LoginForm.tsx`
- [Register form](https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/components/RegisterForm.tsx): `client/src/modules/auth/components/RegisterForm.tsx`
- [Form state](https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/hooks/useAuthForm.ts): `client/src/modules/auth/hooks/useAuthForm.ts`
- [Auth API calls](https://github.com/rahulad12/writespace/blob/master/client/src/modules/auth/services/auth.service.ts): `client/src/modules/auth/services/auth.service.ts`
- [Auth state](https://github.com/rahulad12/writespace/blob/master/client/src/shared/hooks/useAuth.ts): `client/src/shared/hooks/useAuth.ts`
- [HTTP client](https://github.com/rahulad12/writespace/blob/master/client/src/shared/config/apiClient.ts): `client/src/shared/config/apiClient.ts`
- [Route guard](https://github.com/rahulad12/writespace/blob/master/client/src/shared/components/ProtectedRoute.tsx): `client/src/shared/components/ProtectedRoute.tsx`
- [Home page](https://github.com/rahulad12/writespace/blob/master/client/src/modules/home/page.tsx): `client/src/modules/home/page.tsx`

### Express API

- [API app](https://github.com/rahulad12/writespace/blob/master/server/src/app.ts): `server/src/app.ts`
- [Auth routes](https://github.com/rahulad12/writespace/blob/master/server/src/modules/auth/auth.routes.ts): `server/src/modules/auth/auth.routes.ts`
- [Auth controller](https://github.com/rahulad12/writespace/blob/master/server/src/modules/auth/auth.controller.ts): `server/src/modules/auth/auth.controller.ts`
- [JWT middleware](https://github.com/rahulad12/writespace/blob/master/server/src/shared/middleware/auth.middleware.ts): `server/src/shared/middleware/auth.middleware.ts`
- [Request validator](https://github.com/rahulad12/writespace/blob/master/server/src/shared/middleware/validator.ts): `server/src/shared/middleware/validator.ts`
- [PostgreSQL pool](https://github.com/rahulad12/writespace/blob/master/server/src/config/db.ts): `server/src/config/db.ts`

### Writing features

- [Blog routes](https://github.com/rahulad12/writespace/blob/master/server/src/modules/blog/blog.routes.ts): `server/src/modules/blog/blog.routes.ts`
- [Blog controller](https://github.com/rahulad12/writespace/blob/master/server/src/modules/blog/blog.controller.ts): `server/src/modules/blog/blog.controller.ts`
- [Blog service](https://github.com/rahulad12/writespace/blob/master/server/src/modules/blog/blog.service.ts): `server/src/modules/blog/blog.service.ts`
- [Bookmark routes](https://github.com/rahulad12/writespace/blob/master/server/src/modules/bookmark/bookmark.routes.ts): `server/src/modules/bookmark/bookmark.routes.ts`
- [Bookmark controller](https://github.com/rahulad12/writespace/blob/master/server/src/modules/bookmark/bookmark.controller.ts): `server/src/modules/bookmark/bookmark.controller.ts`
- [Bookmark service](https://github.com/rahulad12/writespace/blob/master/server/src/modules/bookmark/bookmark.service.ts): `server/src/modules/bookmark/bookmark.service.ts`
- [Posts capability](https://github.com/rahulad12/writespace/tree/master/server/src/modules/post): `server/src/modules/post`
- [Comments capability](https://github.com/rahulad12/writespace/tree/master/server/src/modules/comment): `server/src/modules/comment`

### Profiles and social

- [User routes](https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.routes.ts): `server/src/modules/user/user.routes.ts`
- [User controller](https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.controller.ts): `server/src/modules/user/user.controller.ts`
- [User service](https://github.com/rahulad12/writespace/blob/master/server/src/modules/user/user.service.ts): `server/src/modules/user/user.service.ts`
- [Follow routes](https://github.com/rahulad12/writespace/blob/master/server/src/modules/follow/follow.routes.ts): `server/src/modules/follow/follow.routes.ts`
- [Follow controller](https://github.com/rahulad12/writespace/blob/master/server/src/modules/follow/follow.controller.ts): `server/src/modules/follow/follow.controller.ts`
- [Follow service](https://github.com/rahulad12/writespace/blob/master/server/src/modules/follow/follow.service.ts): `server/src/modules/follow/follow.service.ts`

### Other components

- **User**
- **PostgreSQL**

## Connections

- User → Client router: uses (evidence: `client/src/App.tsx`)
- Client router → Auth pages: routes to (evidence: `client/src/App.tsx`)
- Client router → Home page: routes to (evidence: `client/src/App.tsx`)
- Client router → Route guard: guards profile (evidence: `client/src/App.tsx`)
- Auth pages → Login form: renders (evidence: `client/src/modules/auth/page.tsx`)
- Auth pages → Register form: renders (evidence: `client/src/modules/auth/page.tsx`)
- Login form → Form state: uses (evidence: `client/src/modules/auth/components/LoginForm.tsx`)
- Register form → Form state: uses (evidence: `client/src/modules/auth/components/RegisterForm.tsx`)
- Login form → Auth API calls: calls (evidence: `client/src/modules/auth/components/LoginForm.tsx`)
- Register form → Auth API calls: calls (evidence: `client/src/modules/auth/components/RegisterForm.tsx`)
- Login form → Auth state: updates (evidence: `client/src/modules/auth/components/LoginForm.tsx`)
- Register form → Auth state: updates (evidence: `client/src/modules/auth/components/RegisterForm.tsx`)
- Auth API calls → HTTP client: sends requests (evidence: `client/src/modules/auth/services/auth.service.ts`)
- Route guard → Auth state: checks (evidence: `client/src/shared/components/ProtectedRoute.tsx`)
- Home page → Auth state: reads (evidence: `client/src/modules/home/page.tsx`)
- Auth API calls → API app: calls auth and user endpoints
- API app → Auth routes: mounts (evidence: `server/src/app.ts`)
- API app → Blog routes: mounts (evidence: `server/src/app.ts`)
- API app → Bookmark routes: mounts (evidence: `server/src/app.ts`)
- API app → User routes: mounts (evidence: `server/src/app.ts`)
- Auth routes → Auth controller: dispatches (evidence: `server/src/modules/auth/auth.routes.ts`)
- Auth routes → Request validator: validates with (evidence: `server/src/modules/auth/auth.routes.ts`)
- Auth controller → PostgreSQL pool: queries (evidence: `server/src/modules/auth/auth.controller.ts`)
- PostgreSQL pool → PostgreSQL: connects
- Blog routes → Blog controller: dispatches (evidence: `server/src/modules/blog/blog.routes.ts`)
- Blog routes → JWT middleware: protects routes (evidence: `server/src/modules/blog/blog.routes.ts`)
- Blog routes → Request validator: validates with (evidence: `server/src/modules/blog/blog.routes.ts`)
- Blog controller → Blog service: calls (evidence: `server/src/modules/blog/blog.controller.ts`)
- Blog service → PostgreSQL pool: queries (evidence: `server/src/modules/blog/blog.service.ts`)
- Bookmark routes → Bookmark controller: dispatches (evidence: `server/src/modules/bookmark/bookmark.routes.ts`)
- Bookmark routes → JWT middleware: protects routes (evidence: `server/src/modules/bookmark/bookmark.routes.ts`)
- Bookmark controller → Bookmark service: calls (evidence: `server/src/modules/bookmark/bookmark.controller.ts`)
- Bookmark service → PostgreSQL pool: queries (evidence: `server/src/modules/bookmark/bookmark.service.ts`)
- API app → Posts capability: may expose
- API app → Comments capability: may expose
- User routes → User controller: dispatches (evidence: `server/src/modules/user/user.routes.ts`)
- User routes → Follow controller: dispatches profile follow queries (evidence: `server/src/modules/user/user.routes.ts`)
- User routes → JWT middleware: protects routes (evidence: `server/src/modules/user/user.routes.ts`)
- User routes → Request validator: validates with (evidence: `server/src/modules/user/user.routes.ts`)
- User controller → User service: calls (evidence: `server/src/modules/user/user.controller.ts`)
- User service → PostgreSQL pool: queries (evidence: `server/src/modules/user/user.service.ts`)
- Follow routes → Follow controller: dispatches (evidence: `server/src/modules/follow/follow.routes.ts`)
- Follow routes → JWT middleware: protects routes (evidence: `server/src/modules/follow/follow.routes.ts`)
- Follow controller → Follow service: calls (evidence: `server/src/modules/follow/follow.controller.ts`)
- Follow service → PostgreSQL pool: queries (evidence: `server/src/modules/follow/follow.service.ts`)
