ntnsndr/protocol-droid
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add logo, PWA manifest, favicon

Browse Source 
- Geometric Companion logo: rounded head, blue outline, green eyes,
  green antenna tip. SVG for crisp rendering at any size.
- Logo appears in header next to site name
- PWA manifest (manifest.json) with 192px and 512px PNG icons
- Favicon (favicon.ico) for browser tab
- Apple touch icon for iOS home screen
- README: logo replacement instructions for whitelabeling

To replace the logo for whitelabeling, just swap frontend/logo.svg
and the icon PNGs. Update <link> tags in index.html if filename changes.
This commit is contained in:
Protocolbot
2026-07-08 18:41:53 -06:00
parent 31492d55d3
commit e9ccb7d3b1
8 changed files with 61 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -2
View File
@@ -73,7 +73,7 @@ protocol-droid/
```
4. The database schema auto-initializes on first API request (creates `data/protocol_droid.db`)
5. Visit the site and register — the **first user to register becomes admin**
5. Optionally load seed protocols: Go to your **profile page** (click your @username) and click **"Load Seed Protocols"** (visible to admins only). This loads 100 example protocols into your library. Can be repeated to re-import seeds.
6. Optionally load seed protocols: Go to the **About** page and click **"Load seed protocols"** (visible to admins only). This loads 6 example protocols into your library in one click. No curl needed.
**No default admin credentials exist.** A fresh deployment has an empty database. The first registration creates the admin account. Seed protocols are optional and must be explicitly loaded.
@@ -122,7 +122,7 @@ cd protocol-droid
php -S localhost:8000
```
The SQLite database is created automatically at `data/protocol_droid.db`. The first registration creates the admin account. To load the 100 sample protocols, go to your **profile page** (click your @username) and click **"Load Seed Protocols"** (admins only).
The SQLite database is created automatically at `data/protocol_droid.db`. The first registration creates the admin account. To load the 6 sample protocols (Round Robin Check-In, Consent Decision-Making, etc.):
```bash
# After registering as admin:
@@ -171,6 +171,17 @@ curl -b cookies.txt -X DELETE http://localhost:8000/api/protocols/round-robin-ch
Protocol Droid is designed to be fully whitelabel-able. Here's how to customize it for your deployment:
### Logo
The logo is an SVG file at `frontend/logo.svg`. It appears in the header next to the site name and as the browser/PWA icon.
To replace it:
1. Create your own SVG logo (or PNG)
2. Replace `frontend/logo.svg` (and `frontend/favicon.ico`, `frontend/icon-192.png`, `frontend/icon-512.png` for PWA icons)
3. If using a different filename, update the `<link>` tags in `frontend/index.html`
For PWA icons, generate 192x192 and 512x512 PNG versions of your logo and save them as `frontend/icon-192.png` and `frontend/icon-512.png`. The web manifest is at `manifest.json` in the project root.
### Site name and tagline
Edit `config.yaml` in the project root: