Skip to content

Commit a92a3b2

Browse files
committed
docs: sync README project structure with repository
1 parent 99ea18a commit a92a3b2

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,25 +87,37 @@ This API powers a full content management system for libraries with role-based a
8787
## Project Structure
8888

8989
```
90+
├── .env.example # Env template (copy to .env)
91+
├── .github/
92+
│ ├── workflows/ # CI (ci.yml), release (release.yml)
93+
│ └── pull_request_template.md
9094
├── config/
9195
│ ├── bucket-storage/ # Cloudinary setup
9296
│ ├── cors/ # CORS config
93-
│ ├── database/ # Schema, migrations, seed, storage
97+
│ ├── database/ # Schema, migrations, seed, storage, db
9498
│ └── swagger.ts # OpenAPI spec
99+
├── drizzle/ # SQL migrations and meta
95100
├── src/
96101
│ ├── config/ # Env validation (Zod)
97-
│ ├── controllers/ # Request handlers
102+
│ ├── controllers/ # Request handlers
98103
│ ├── middlewares/ # Auth, validation, error-handler, logger, rate-limiters
99104
│ ├── routes/ # API route definitions
100105
│ ├── services/ # Business logic (drizzle, email)
101-
│ ├── types/ # TypeScript declarations
106+
│ ├── types/ # TypeScript declarations (e.g. express.d.ts)
102107
│ ├── utils/ # Errors, validations, api-response
103108
│ └── validations/ # Zod request schemas
104109
├── tests/
105110
│ ├── helpers/ # Mocks (Request, Response, session)
111+
│ ├── setup.ts
106112
│ └── unit/ # Controllers, services, middlewares, routes, utils
107-
├── .github/workflows/ # CI pipeline
113+
├── scripts/ # git-flow and tooling
108114
├── index.ts # App entry point
115+
├── drizzle.config.ts
116+
├── jest.config.js
117+
├── tsconfig.json
118+
├── package.json
119+
├── pnpm-lock.yaml
120+
├── pnpm-workspace.yaml
109121
└── render.yaml # Render deployment config
110122
```
111123

index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { registerRoutes } from "./src/routes";
1717
import { Pool as NeonPool } from "@neondatabase/serverless";
1818
import { Pool } from "pg";
1919
import errorHandler from "./src/middlewares/error-handler";
20-
import logger from "./src/middlewares/logger";
20+
import { requestLogger } from "./src/middlewares/logger";
2121
import helmet from "helmet";
2222
import cors from "cors";
2323
import { env } from "./src/config/env";
@@ -76,7 +76,7 @@ app.use(session({
7676
}));
7777

7878
// Request logging middleware
79-
app.use(logger);
79+
app.use(requestLogger);
8080

8181
(async () => {
8282
const server = await registerRoutes("/api/v1", app);

0 commit comments

Comments
 (0)