docs/tsclient.md

# Api client TypeScript

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

This client is made with [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen)
and Meet's backend OpenAPI schema (available [here](http://localhost:8071/v1.0/swagger/) 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

```sh
$ cd src/tsclient
$ yarn install
```

## Generate the client

```sh
yarn generate:api:client:local <output_path_for_generated_client>
```
✨(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-01-09 15:30:36 +01:00			`# Api client TypeScript`

			`The backend application can automatically create a TypeScript client to be used in frontend`
🚚(tsclient) rename Impress to Meet I have updated all references of "Impress" to "Meet" in the tsclient. Also, I forgot to rename the repository link in the mail package.json, my bad, it's fixed. 2024-07-01 19:03:52 +02:00			`applications. It is used in the Meet front application itself.`
✨(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-01-09 15:30:36 +01:00
			`This client is made with [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen)`
🚚(tsclient) rename Impress to Meet I have updated all references of "Impress" to "Meet" in the tsclient. Also, I forgot to rename the repository link in the mail package.json, my bad, it's fixed. 2024-07-01 19:03:52 +02:00			`and Meet's backend OpenAPI schema (available [here](http://localhost:8071/v1.0/swagger/) if you have the backend running).`
✨(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-01-09 15:30:36 +01:00
			`## Requirements`

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

			`## Install openApiClientJs`

			```sh
			`$ cd src/tsclient`
			`$ yarn install`
			```

			`## Generate the client`

			```sh
			`yarn generate:api:client:local <output_path_for_generated_client>`
			```