80 lines
1.5 KiB
Markdown
80 lines
1.5 KiB
Markdown
# RSS Newsfeed Viewer (Flask)
|
|
|
|
Responsive RSS viewer that shows **headlines slide-by-slide** (latest **5** items), with a placeholder logo, feed title, and subtle background + slide animations.
|
|
|
|
## Run locally
|
|
|
|
```bat
|
|
python -m venv .venv
|
|
.venv\Scripts\activate
|
|
pip install -r requirements.txt
|
|
python app.py
|
|
```
|
|
|
|
Open: http://127.0.0.1:5000
|
|
|
|
### Optional: choose a different feed
|
|
|
|
```text
|
|
http://127.0.0.1:5000/?url=https%3A%2F%2Fexample.com%2Frss.xml
|
|
```
|
|
|
|
Or set an env var:
|
|
|
|
```bat
|
|
set RSS_URL=https://example.com/rss.xml
|
|
python app.py
|
|
```
|
|
|
|
### Optional: set a custom logo
|
|
|
|
By default a bundled placeholder logo is used. To override it:
|
|
|
|
```bat
|
|
set LOGO_URL=https://example.com/logo.png
|
|
python app.py
|
|
```
|
|
|
|
## Run with Docker Compose
|
|
|
|
Edit `docker-compose.yml` and adjust:
|
|
|
|
- `RSS_URL` (RSS feed)
|
|
- `LOGO_URL` (logo image URL)
|
|
|
|
Then run:
|
|
|
|
```bash
|
|
docker compose up --build
|
|
```
|
|
|
|
Docker runs the app using **Gunicorn** (production WSGI server).
|
|
|
|
Open: http://127.0.0.1:5000
|
|
|
|
## Release (git + docker)
|
|
|
|
There is a helper script that:
|
|
|
|
- updates `release.py` with the version
|
|
- commits + pushes to git using the version as the commit message
|
|
- builds + pushes Docker images tagged with the version (and optionally `latest`)
|
|
|
|
Example:
|
|
|
|
```bash
|
|
python release_tool.py v1.0.2 --image git.alphen.cloud/bramval/rssfeedviewer --also-latest
|
|
```
|
|
|
|
Dry run (prints commands only):
|
|
|
|
```bash
|
|
python release_tool.py v1.0.2 --dry-run
|
|
```
|
|
|
|
## Controls
|
|
|
|
- Click/tap: next headline
|
|
- Left/right arrow keys: previous/next
|
|
- Space: pause/resume
|