Skip to content

Commit 49fe982

Browse files
committed
docs: update README
1 parent ace67bf commit 49fe982

1 file changed

Lines changed: 29 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,13 @@ We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for gu
7272
| Library | Version | Description |
7373
| --- | --- | --- |
7474
| Express | `5.2.1` | Node.js web framework for building APIs and web servers. |
75-
| Mongoose | `9.4.1` | ODM for MongoDB that provides schema-based modeling and data interaction. |
76-
| Zod | `4.3.6` | TypeScript-first schema validation for request payloads and query parameters. |
77-
| Nodemon | `3.1.14` | Development tool that automatically restarts the server on file changes. |
78-
| tsx | `4.21.0` | Executes TypeScript and TSX files directly, ideal for dev and script running. |
79-
| tsc-alias | `1.8.16` | Rewrites path aliases in compiled TypeScript output (`tsconfig` paths). |
80-
| ESlint | `10.2.1` | Linting tool that enforces code style, quality, and formatting rules. |
75+
| Mongoose | `9.7.0` | ODM for MongoDB that provides schema-based modeling and data interaction. |
76+
| Zod | `4.4.3` | TypeScript-first schema validation for request payloads and query parameters. |
77+
| tsx | `4.22.4` | Executes TypeScript and TSX files directly, ideal for dev and script running. |
78+
| tsc-alias | `1.8.17` | Rewrites path aliases in compiled TypeScript output (`tsconfig` paths). |
79+
| ESlint | `10.5.0` | Linting tool that enforces code style, quality, and formatting rules. |
8180
| @asteasolutions/zod-to-openapi | `8.5.0` | Generates OpenAPI YAML and JSON files from Zod schemas. |
82-
| @redocly/cli | `2.28.1` | Generates an API documentation using an OpenAPI YAML input. |
81+
| @redocly/cli | `2.32.2` | Generates an API documentation using an OpenAPI YAML input. |
8382
| swagger-ui-express | `4.1.8` | Generates a Swagger UI API documentation using an OpenAPI JSON input. |
8483

8584
</details>
@@ -276,6 +275,28 @@ See [Docker Hub: weaponsforge/ph-regions](https://hub.docker.com/r/weaponsforge/
276275
</details>
277276
<br>
278277

278+
## 🔖 Other Notes
279+
280+
### Updating Scalar API Documentation
281+
282+
> [!IMPORTANT]
283+
> This project uses the HTML/CSS/JavaScript version of [Scalar](https://github.com/ScalaR/ScalaR) for API documentation.
284+
285+
1. Check for the latest Scalar standalone script version:
286+
- https://cdn.jsdelivr.net/npm/@scalar/api-reference
287+
2. Compare it with the version referenced in `/server/public/index.html`.
288+
3. If a newer version exists:
289+
- Update the script URL.
290+
- Generate a new SRI hash:
291+
292+
```bash
293+
/server/scripts/genSriHash <full-script-url>
294+
```
295+
296+
- Update the script's `integrity` attribute with the generated hash.
297+
298+
<br>
299+
279300
## 📜 Available Scripts
280301
281302
These scripts, defined in the `"/server/package.json"` file, are compatible with running in Node and Docker. They run various TypeScript scripts, tests, and processes for code base management.
@@ -464,6 +485,7 @@ This repository deploys the latest production API and documentation to Vercel af
464485
- [Redocly CLI Cookbook](https://github.com/Redocly/redocly-cli-cookbook)
465486
- [Redoc Demo](https://redocly.github.io/redoc/)
466487
- [Swagger Editor (Online)](https://swagger.io/tools/swagger-editor/)
488+
- [SRI Hash Generator](https://srihash.org/)
467489

468490
@weaponsforge<br>
469491
20250711<br>

0 commit comments

Comments
 (0)