Files
meet/docs/tsclient.md
Samuel Paccoud - DINUM 5b1a2b20de (project) Django boilerplate
This commit introduces a boilerplate inspired by https://github.com/numerique-gouv/impress.
The code has been cleaned to remove unnecessary Impress logic and dependencies.

Changes made:
- Removed Minio, WebRTC, and create bucket from the stack.
- Removed the Next.js frontend (it will be replaced by Vite).
- Cleaned up impress-specific backend logics.

The whole stack remains functional:
- All tests pass.
- Linter checks pass.
- Agent Connexion sources are already set-up.

Why clear out the code?

To adhere to the KISS principle, we aim to maintain a minimalist codebase. Cloning Impress
allowed us to quickly inherit its code quality tools and deployment configurations for staging,
pre-production, and production environments.

What’s broken?
- The tsclient is not functional anymore.
- Some make commands need to be fixed.
- Helm sources are outdated.
- Naming across the project sources are inconsistent (impress, visio, etc.)
- CI is not configured properly.

This list might be incomplete. Let's grind it.
2024-06-25 12:48:54 +02:00

739 B

Api client TypeScript

The backend application can automatically create a TypeScript client to be used in frontend applications. It is used in the impress front application itself.

This client is made with openapi-typescript-codegen and impress's backend OpenAPI schema (available here if you have the backend running).

Requirements

We'll need the online OpenAPI schema generated by swagger. Therefore you will first need to install the backend application.

Install openApiClientJs

$ cd src/tsclient
$ yarn install

Generate the client

yarn generate:api:client:local <output_path_for_generated_client>