repertory/README.md
2026-06-09 15:04:27 -04:00

31 lines
988 B
Markdown

# Repertory — frontend
Static single-page app for browsing and editing your tune repertory.
## Local development
```bash
cp config.example.js config.js
# edit config.js — set apiUrl and apiKey to match your local .env
python -m http.server 8080
# open http://localhost:8080
```
`config.js` is gitignored and never deployed to S3. It pre-fills the
connection bar so you don't have to type the API URL and key on every page
load. See `config.example.js` for the full explanation of how this works.
## Deployment
This is a fully static site (HTML + CSS + JS, no build step).
Upload these files to your S3 bucket — `config.js` is intentionally excluded:
```bash
aws s3 sync . s3://your-bucket-name/ \
--exclude "*" \
--include "index.html" \
--include "style.css" \
--include "app.js"
```
In production, enter your API URL and key in the connection bar at the top of the page. These are saved in `sessionStorage` so you only need to enter them once per browser session.