Add client in frontend and client generation (#569)

This commit is contained in:
Alejandra
2023-12-26 10:51:46 -05:00
committed by GitHub
parent 311939e640
commit 49d610e443
29 changed files with 1347 additions and 27 deletions

View File

@@ -1,30 +1,17 @@
# React + TypeScript + Vite
# Full Stack FastAPI and PostgreSQL - Frontend
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Generate Client
Currently, two official plugins are available:
- Start the Docker Compose stack.
- Download the OpenAPI JSON file from `http://localhost/api/v1/openapi.json` and copy it to a new file `openapi.json` next to the `package.json` file.
- To simplify the names in the generated frontend client code, modifying the `openapi.json` file, run:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
## Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level `parserOptions` property like this:
```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```bash
node modify-openapi-operationids.js
```
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
- To generate or update the frontend client, run:
```bash
npm run generate-client
```