reddit-slideshow/README.md
moonstar-x f4c4345893
All checks were successful
Gitea - Public/reddit-slideshow/pipeline/head This commit looks good
Updated README.
2023-06-02 14:04:57 -05:00

65 lines
1.5 KiB
Markdown

# reddit-slideshow
Site that displays a slideshow with images/gifs obtained from reddit. By default images will be fetched from reddit frontpage.
Currently hosted at https://redditslideshow.com/
## Additional Info
My contribution to this is:
- Serving the application through a Docker image.
- Added a basic landing page with easy to access links for specific slideshows.
### Hosting with Docker
You can base yourself off this `docker-compose.yml` file:
```yaml
version: "3.9"
services:
service:
image: code.moonstar-x.dev/public/reddit-slideshow:latest
restart: unless-stopped
volumes:
- ./settings.json:/usr/share/nginx/html/settings.json
ports:
- 8080:8080
environment:
- TZ=America/Guayaquil
```
The `settings.json` file should contain something like this:
```json
{
"slideshows": [
"funny",
["memes", "pics"]
]
}
```
Single subreddits are strings whereas multireddits are arrays.
## Usage
You can go to the previous/next slide by pressing `A` or `D` respectively, or by using the arrow keys.
You can add, for example, `/r/pics` to the url and data will be fetched from reddit.com/r/pics. Try the following URLs:
- https://redditslideshow.com/r/pics
- https://redditslideshow.com/r/art
- https://redditslideshow.com/r/aww
## Todo
- Detect / handle invalid URLs.
- Better error handling.
- Add tests.
- NSFW filter (some logic already implemented).
- Audio on WebMs.
---
Made with React using `create-react-app`, based on http://redditp.com/