rimgo/README.md
2022-01-17 23:54:34 +01:00

60 lines
1.2 KiB
Markdown

# rimgo: An alternative frontend for Imgur
A Go rewrite of [rimgu](https://codeberg.org/3np/rimgu).
Rimgu was inspired by:
* [SearX](https://github.com/searx/searx)
* [teddit](https://codeberg.org/teddit/teddit)
* [Nitter](https://github.com/zedeus/nitter)
* [Bibliogram](https://sr.ht/~cadence/bibliogram/)
Features:
- [ ] URL-compatible with i.imgur.com - just replace the domain in the URL
- [ ] Images and videos (gifv, mp4) returned directly
- [ ] Galleries with comments
- [x] Albums
- [ ] User page
- [ ] Tag page
- [ ] Supports http(s) forward proxy
- [ ] Streaming
- [ ] Localization/internationalization
- [ ] Pretty CSS styling (responsive?)
- [ ] Support for other popular image sites than only imgur
- [ ] Filtering and exploration on user/tags pages
- [ ] Responsive scaling of videos on user/tags pages
- [ ] Logo
- [ ] SOCKS5 proxy support
## Building
### Locally
Dependencies:
* Go version X or later
```
$ npm install && npm run build
```
### Docker
```
$ docker-compose up -d
```
## Running
### Locally
```
$ ./rimgo
```
If you decide to run a public instance, consider opening an issue to have it listed here :)
## Contributing
PRs are welcome!