mirror of
https://github.com/fastapi/full-stack-fastapi-template.git
synced 2026-11-03 20:36:27 +00:00
⬆ Bump the npm-packages group across 1 directory with 30 updates (#2525)
Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Yurii Motov <yurii.motov.monte@gmail.com> Co-authored-by: pr-push[bot] <pr-push[bot]@users.noreply.github.com>
This commit is contained in:
+19
-19
@@ -27,17 +27,17 @@ Check `frontend/package.json` to see the other available commands.
|
||||
|
||||
If you are developing an API-only app and want to remove the frontend, you can do it easily:
|
||||
|
||||
* Remove the `./frontend` directory.
|
||||
- Remove the `./frontend` directory.
|
||||
|
||||
* In the `backend/app/main.py` file, remove the `app.frontend()` call.
|
||||
- In the `backend/app/main.py` file, remove the `app.frontend()` call.
|
||||
|
||||
* In the `backend/Dockerfile` file, remove the frontend build stage and the `COPY --from=frontend-build` instruction.
|
||||
- In the `backend/Dockerfile` file, remove the frontend build stage and the `COPY --from=frontend-build` instruction.
|
||||
|
||||
* In the `compose.override.yml` file, remove the `playwright` service.
|
||||
- In the `compose.override.yml` file, remove the `playwright` service.
|
||||
|
||||
* In the `.github/workflows/deploy.yml` file, remove the **Set up Bun**, **Install frontend dependencies**, and **Build frontend** steps.
|
||||
- In the `.github/workflows/deploy.yml` file, remove the **Set up Bun**, **Install frontend dependencies**, and **Build frontend** steps.
|
||||
|
||||
* In the `.fastapicloudignore` file, remove the `!backend/app/frontend/` entry.
|
||||
- In the `.fastapicloudignore` file, remove the `!backend/app/frontend/` entry.
|
||||
|
||||
Done, you now have an API-only app. 🤓
|
||||
|
||||
@@ -45,27 +45,27 @@ Done, you now have an API-only app. 🤓
|
||||
|
||||
### Automatically
|
||||
|
||||
* From the project root, run the script:
|
||||
- From the project root, run the script:
|
||||
|
||||
```bash
|
||||
bash ./scripts/generate-client.sh
|
||||
```
|
||||
|
||||
* Commit the changes.
|
||||
- Commit the changes.
|
||||
|
||||
### Manually
|
||||
|
||||
* Make sure the backend is running.
|
||||
- Make sure the backend is running.
|
||||
|
||||
* Download the OpenAPI JSON file from `http://localhost:8000/api/v1/openapi.json` and copy it to a new file `openapi.json` at the root of the `frontend` directory.
|
||||
- Download the OpenAPI JSON file from `http://localhost:8000/api/v1/openapi.json` and copy it to a new file `openapi.json` at the root of the `frontend` directory.
|
||||
|
||||
* To generate the frontend client, run:
|
||||
- To generate the frontend client, run:
|
||||
|
||||
```bash
|
||||
bun run generate-client
|
||||
```
|
||||
|
||||
* Commit the changes.
|
||||
- Commit the changes.
|
||||
|
||||
Regenerate the client whenever backend changes affect the OpenAPI schema.
|
||||
|
||||
@@ -83,13 +83,13 @@ Then, when you run the frontend, it will use that URL as the base URL for the AP
|
||||
|
||||
The frontend code is structured as follows:
|
||||
|
||||
* `frontend/src` - The main frontend code.
|
||||
* `frontend/public` - Static assets.
|
||||
* `frontend/src/client` - The generated OpenAPI client.
|
||||
* `frontend/src/components` - The components of the frontend, including the shadcn/ui components in `frontend/src/components/ui`.
|
||||
* `frontend/src/hooks` - Custom hooks.
|
||||
* `frontend/src/lib` - Shared frontend utilities.
|
||||
* `frontend/src/routes` - The frontend routes and pages.
|
||||
- `frontend/src` - The main frontend code.
|
||||
- `frontend/public` - Static assets.
|
||||
- `frontend/src/client` - The generated OpenAPI client.
|
||||
- `frontend/src/components` - The components of the frontend, including the shadcn/ui components in `frontend/src/components/ui`.
|
||||
- `frontend/src/hooks` - Custom hooks.
|
||||
- `frontend/src/lib` - Shared frontend utilities.
|
||||
- `frontend/src/routes` - The frontend routes and pages.
|
||||
|
||||
## End-to-End Testing with Playwright
|
||||
|
||||
|
||||
Reference in New Issue
Block a user