Initial commit: RSS feed viewer with Docker setup
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# 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
|
||||
```
|
||||
|
||||
Open: http://127.0.0.1:5000
|
||||
|
||||
## Controls
|
||||
|
||||
- Click/tap: next headline
|
||||
- Left/right arrow keys: previous/next
|
||||
- Space: pause/resume
|
||||
Reference in New Issue
Block a user