Skip to content

Commit 8652b4c

Browse files
Merge pull request #9 from fastapi-startkit/docs-fix
feat: docs fixed
2 parents ff34ea9 + b11dc38 commit 8652b4c

2 files changed

Lines changed: 19 additions & 5 deletions

File tree

docs/frontend/vite.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,29 @@ app = Application(
2626
)
2727
```
2828

29-
Publish the default config file:
29+
Publish the default config and asset files:
3030

3131
```bash
32-
python artisan vendor:publish --provider=vite
32+
python artisan provider:publish --provider=vite
3333
```
3434

35-
This creates `config/vite.py` in your project.
35+
This creates the following files in your project:
36+
37+
- `config/vite.py`: FastAPI configuration for Vite.
38+
- `package.json`: Vite dependencies and scripts.
39+
- `vite.config.js`: Vite configuration with Tailwind CSS support.
40+
- `resources/js/app.js`: Main JavaScript entry point.
41+
- `resources/css/app.css`: Main CSS entry point.
42+
43+
After publishing, install the frontend dependencies and start the development server:
44+
45+
```bash
46+
npm install
47+
npm run dev
48+
```
49+
50+
> [!NOTE]
51+
> Ensure `APP_URL` in your `.env` matches your FastAPI server URL (e.g., `http://127.0.0.1:8000`) so that Vite's Hot Module Replacement (HMR) can correctly communicate with the backend.
3652
3753
---
3854

docs/logging.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,5 +187,3 @@ Sends logs to the system logger.
187187
- `level`: Minimum logging level.
188188

189189
---
190-
191-

0 commit comments

Comments
 (0)