libreddit

(โ˜… 5,198)

Private front-end for Reddit

  • .gitattributes
  • .gitignore
  • .replit
  • app.json
  • build.rs
  • Cargo.lock
  • Cargo.toml
  • CREDITS
  • docker-compose.yml
  • Dockerfile
  • Dockerfile.arm
  • Dockerfile.armv7
  • heroku.yml
  • LICENSE
  • README.md
  • rustfmt.toml

# Installation Guide

1. Get the code
git clone https://github.com/libreddit/libreddit

Downloads the entire project code from GitHub to your computer.

cd libreddit

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
cargo install libreddit

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull libreddit/libreddit

Type this command into your terminal and run it.

docker run -d --name libreddit -p 8080:8080 libreddit/libreddit

Runs the built image as an actual container.

docker run -d --name libreddit -p 80:8080 libreddit/libreddit

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install libreddit

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation