docs: rewrite QUICKSTART.md with step-by-step guide and screenshots - #40
docs: rewrite QUICKSTART.md with step-by-step guide and screenshots#40zuudevs wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1310a53542
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | URL | Keterangan | | ||
| |-----|------------| | ||
| | http://localhost:8000/docs | 📖 Swagger UI — Dokumentasi API interaktif | | ||
| | http://localhost:8000/api/meters | 📡 Daftar meter yang terdaftar | |
There was a problem hiding this comment.
Remove nonexistent
/api/meters verification endpoint
The verification table tells users to open http://localhost:8000/api/meters, but the API router does not define a /api/meters route (it defines /api/readings, /api/alerts, /api/anomalies, /api/status, etc. in backend/app/routes.py), so this step will always return 404 and makes the quickstart appear broken even when setup is correct.
Useful? React with 👍 / 👎.
|
|
||
| ### 2.2. Seed Database (Pertama Kali) | ||
|
|
||
| Database sudah terisi data contoh (`gridshield.db`). Jika ingin reset: |
There was a problem hiding this comment.
State that sample data requires running
seed.py
This line says the database already contains sample data, but the repository does not ship a tracked gridshield.db file and backend startup only creates tables (Base.metadata.create_all(...) in backend/app/main.py), so fresh clones start empty unless seed.py is executed; users following this text can end up with blank dashboard pages and think ingestion is failing.
Useful? React with 👍 / 👎.
Changes