Merge pull request #1 from topcoder-platform/develop

README update

Author: jmgasper

README.md

@@ -1,11 +1,11 @@
-# Topcoder Billing Accounts & Clients API (NestJS + Prisma, CommonJS)
+# Topcoder Billing Accounts & Clients API (NestJS + Prisma)
 
-**What you get:**
-- NestJS project with CommonJS `tsconfig.json`
+**Project structure:**
+- NestJS project
 - Prisma schema for Clients, Billing Accounts, Locked & Consumed amounts
 - Endpoints:
-  - `GET /billing-accounts` (filter, sort, pagination, userId + clientId filters)
-  - `POST /billing-accounts` (Admin role or M2M scopes)
+  - `GET /billing-accounts` 
+  - `POST /billing-accounts` 
   - `GET /billing-accounts/:billingAccountId` (includes locked/consumed arrays + budget totals)
   - `PATCH /billing-accounts/:billingAccountId`
   - `PATCH /billing-accounts/:billingAccountId/lock-amount` (0 amount = unlock)
@@ -14,9 +14,9 @@
   - `GET /clients/:clientId`
   - `PATCH /clients/:clientId`
 
-**Auth**
-- Express-style JWT middleware via `tc-core-library-js` attaches `req.authUser`
-- Guards for Roles (e.g., `Administrator`) and Scopes (M2M) are provided.
+**Authorization**
+- JWT middleware via `tc-core-library-js` attaches `req.authUser`
+- Guards for Roles (e.g., `Administrator`) and M2M Scopes are provided.
 - Configure env: `AUTH_SECRET` or `AUTH0_URL/AUDIENCE/ISSUER` as needed.
 
 ## Quickstart
@@ -25,13 +25,11 @@
 cp .env.example .env
 # edit .env and set DATABASE_URL, auth vars, etc.
 
-npm i
-npm run prisma:generate
-npm run prisma:migrate
+pnpm i
+pnpm run prisma:generate
+pnpm run prisma:migrate
 
-npm run dev
+pnpm run dev
 # or
-npm run build && npm start
+pnpm run build && pnpm start
 ```
-
-> If you need integer IDs for billing accounts/clients, switch `id` fields in `prisma/schema.prisma` to `BigInt` and adjust DTOs accordingly.