Skip to content

Align README and QUICKSTART docs with current repo, paths, and health-check endpoint #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfeen87 merged 1 commit into from
Apr 16, 2026
Merged

Align README and QUICKSTART docs with current repo, paths, and health-check endpoint #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ phase–memory operator (PAPER.md §3–4) via a REST API and a browser UI.
| Endpoint | Description |
|----------|-------------|
| `GET /` | Dashboard UI — status, metrics, configuration, live logs, validation |
| `GET /api/status` | System status (version, uptime, pipeline name) |
| `GET /ping` | System status (version, uptime, pipeline name) |

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

The endpoint table now says GET /ping returns “System status (version, uptime, pipeline name)”, but /ping in server/app.py only returns {"pong": true} and the status/version/uptime fields live under GET /api/status (JWT-protected). Update the table description to match /ping, and keep/restore a separate /api/status entry (noting auth) if you want to document system status.

Suggested change
| `GET /ping` | System status (version, uptime, pipeline name) |
| `GET /ping` | Lightweight health check (`{"pong": true}`) |
| `GET /api/status` | System status (version, uptime, pipeline name) — JWT required |

Copilot uses AI. Check for mistakes.
| `GET /api/logs?n=50` | Last *n* structured log entries |
| `GET /api/config` | Current operator parameters (M, α, baseline, fs) |
| `POST /api/config` | Update operator parameters at runtime |
Expand All @@ -431,11 +431,11 @@ phase–memory operator (PAPER.md §3–4) via a REST API and a browser UI.
3. Connect the repository and select **"Use render.yaml"** — Render will read
[`render.yaml`](render.yaml) automatically.
4. Click **Deploy**. Render will:
- run `pip install -r server/requirements.txt`
- run `pip install -r requirements.txt`
- start `python server/app.py` bound to the `$PORT` it provides

> The service is defined in [`render.yaml`](render.yaml) with
> `healthCheckPath: /api/status` so Render can verify liveness automatically.
> `healthCheckPath: /ping` so Render can verify liveness automatically.

### Environment variables

Expand Down Expand Up @@ -476,7 +476,7 @@ entries as JSON and is polled every 5 seconds by the browser UI.
### Running locally

```bash
pip install -r server/requirements.txt
pip install -r requirements.txt
python server/app.py # listens on http://localhost:5000
# or with a custom port:
PORT=8080 python server/app.py
Expand Down
10 changes: 4 additions & 6 deletions docs/QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,18 @@ We're working on simple apps you can just install:
iOS: [Link to TestFlight Beta] (waiting approval)
Android: [Link to APK] (in progress)

Want to help build these? See CONTRIBUTING.md

Option 2: For Developers - Build It Yourself
iOS (Xcode Required)

Clone the repo:

bash git clone https://github.com/dfeen87/respirosync.git
bash git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring
cd respirosync

Comment on lines +27 to 29

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

After git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring the default checkout directory will be Smartphone-Based-Chest-Monitoring/, not respirosync/. Either change the next line to cd Smartphone-Based-Chest-Monitoring or use git clone … respirosync if you want to keep cd respirosync.

Copilot uses AI. Check for mistakes.
Open the example project:

bash cd examples/ios
bash cd ios/
open RespiroSyncDemo.xcodeproj

Comment on lines +32 to 34

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

The iOS instructions still reference open RespiroSyncDemo.xcodeproj, but there are no .xcodeproj/.xcworkspace files in the repository under ios/ (only ios/RespiroSyncDemo/ContentView.swift…). Update this step to point to the actual Xcode project/workspace (or update the repo to include it if it’s expected to exist).

Copilot uses AI. Check for mistakes.
Connect your iPhone and hit Run (▶️ button in Xcode)
Expand All @@ -40,12 +39,12 @@ Android (Android Studio Required)

Clone the repo:

bash git clone https://github.com/dfeen87/respirosync.git
bash git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring
cd respirosync

Comment on lines +42 to 44

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

Same issue as above: cloning https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring won’t create a respirosync/ directory unless you specify it as the target dir. Update cd respirosync accordingly (or change the clone command to include a destination folder name).

Copilot uses AI. Check for mistakes.
Open in Android Studio:

File → Open → Select respirosync/examples/android
File → Open → Select android/

Comment on lines 45 to 48

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

The Android step says to open android/ in Android Studio, but the android/ subtree in this repo doesn’t contain the usual project files (settings.gradle, build.gradle, AndroidManifest.xml, etc.), so Android Studio won’t be able to import/build from these instructions as written. Either point to the correct Android Studio project directory (if different) or clarify that this repo contains only the Android integration sources, not a buildable demo app.

Copilot uses AI. Check for mistakes.
Connect your Android phone and hit Run (▶️ button)
Put phone in chest vest and start session
Expand Down Expand Up @@ -188,7 +187,6 @@ Once you've tested it:
🐛 Report bugs on GitHub Issues
💬 Share your results in Discussions
📸 Post your DIY vest (we'll feature it!)
🤝 Help improve it - see CONTRIBUTING.md

Get Help

Expand Down
Loading