Doc: add documentation according to the addition of tuyau (#14)

Author: prisca-c

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Added
 - Added `BYPASS_LOGIN` env variable to bypass social login for development
+- Add `Tuyau` to handle a type-safe api client to sync our frontend with our backend
 
 ### Changes
 - Move from `eslint & prettier` to `Biomejs` for code quality

Makefile

@@ -96,4 +96,11 @@ reset-db: rollback migrate seed
 
 .PHONY: generate-tuyau
 generate-tuyau:
-	node ace tuyau:generate && node --loader ts-node/esm scripts/tuyau_api_tsignore.ts
+	node ace tuyau:generate
+
+.PHONY: add-tsnocheck-to-tuyau
+add-tsnocheck-to-tuyau:
+	node --loader ts-node/esm scripts/tuyau_api_tsignore.ts
+
+.PHONY: tuyau
+tuyau: generate-tuyau add-tsnocheck-to-tuyau

README.md

@@ -40,6 +40,7 @@ The `Makefile` provides shortcuts for common tasks. Below is a list of available
 
 - **`make jobs`** - Run background jobs with `pnpm jobs:run`.
 - **`make offline`** - Set `BYPASS_LOGIN=1` in `.env` to enable offline mode.
+- **`make tuyau`** - Run the `tuyau` command to generate/re-generate api types.
 
 ## Setup Instructions