aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: bf30ae690cab919f63af31ab7077ac1d0a075fe0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# reddit-lite
Available at [reddit.jamesbarnett.io](https://reddit.jamesbarnett.io)

A lightweight, minimal, readonly Reddit client, designed for mobile devices or slow connections.
![comments](https://jamesbarnett.io/files/reddit-lite/screenshots/rl3.png)

## Running locally
Reddit-lite is written in Kotlin using the [Spring Boot](https://spring.io/projects/spring-boot) framework.
You will need Java 8 or later to run it.

```sh
git clone https://github.com/jamesbarnett91/reddit-lite && cd reddit-lite
./gradlew run
```
Alternatively, you can pull the `jbarnett/reddit-lite` docker image and run that.
```sh
docker run --name reddit-lite -d -p 8080:8080 jbarnett/reddit-lite
```
Then navigate to `localhost:8080` in your browser.

Or go to [reddit.jamesbarnett.io)](https://reddit.jamesbarnett.io) for a hosted version.

## TODOs
* ~~option to hide thumbnails~~ [done]
* ~~collapsible comments~~ [done]
* async load of deeply nested comments
* sort posts/comments by top/hot/new
* view subreddit info/sidebar
* highlight gilded posts/comments
* highlight comments from OP
* should probably write some tests...