From 2ee8c75269b69e8acbdbb5eb7ed4f48436967e11 Mon Sep 17 00:00:00 2001 From: Gilles Lazures Date: Tue, 16 Dec 2025 03:52:22 +0100 Subject: [PATCH] Actualiser README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 00a83fb..439c9ed 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # Base-REST-API +A robust, modular, and secure REST API boilerplate built with **Node.js** and **Express**. +It features a **recursive file loader** for routes and schemas, along with a powerful validation middleware using **Zod**. + +## 🚀 Features + +- **Automated Loading**: Recursively loads routes and validation schemas from the file system. +- **Strict Validation**: Request bodies and query parameters are validated using [Zod](https://zod.dev/) before reaching the controller. +- **Clean Architecture**: Separation of concerns with `Routes` (HTTP layer), `Services` (Business logic), and `Schemas` (Validation). +- **Security First**: Inputs are stripped of unknown fields automatically. +- **Custom Logger**: Integrated color-coded logging system for development and file logging for production. +- **Error Handling**: Standardized JSON error responses. + +## 📦 Installation + +1. **Clone the repository** + ```bash + git clone [https://gitea.azures.fr/azures04/Base-REST-API.git](https://gitea.azures.fr/azures04/Base-REST-API.git) + cd Base-REST-API \ No newline at end of file