Skip to content

docs: rewrite QUICKSTART.md with step-by-step guide and screenshots - #40

Closed
zuudevs wants to merge 2 commits into
mainfrom
docs/quickstart-rewrite
Closed

docs: rewrite QUICKSTART.md with step-by-step guide and screenshots#40
zuudevs wants to merge 2 commits into
mainfrom
docs/quickstart-rewrite

Conversation

@zuudevs

@zuudevs zuudevs commented Mar 5, 2026

Copy link
Copy Markdown
Owner

Changes

  • Rewrote QUICKSTART.md with easier step-by-step instructions (Bahasa Indonesia)
  • Added 5 screenshots (Dashboard, Alerts, Anomalies, Fleet, Swagger UI)
  • Covers all 3 components: Backend (FastAPI), Frontend (Vite+Chart.js), Firmware (ESP-IDF)
  • Added troubleshooting section
  • Added architecture diagram

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/QUICKSTART.md
| URL | Keterangan |
|-----|------------|
| http://localhost:8000/docs | 📖 Swagger UI — Dokumentasi API interaktif |
| http://localhost:8000/api/meters | 📡 Daftar meter yang terdaftar |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread docs/QUICKSTART.md

### 2.2. Seed Database (Pertama Kali)

Database sudah terisi data contoh (`gridshield.db`). Jika ingin reset:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@zuudevs zuudevs closed this Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant