https://github.com/freedit-org/freedit
The safest and lightest forum, powered by rust.
https://github.com/freedit-org/freedit
bbs forum reddit rust twitter
Last synced: 2 months ago
JSON representation
The safest and lightest forum, powered by rust.
- Host: GitHub
- URL: https://github.com/freedit-org/freedit
- Owner: freedit-org
- License: mit
- Created: 2022-06-21T18:11:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T01:29:02.000Z (over 1 year ago)
- Last Synced: 2024-11-08T02:22:52.092Z (over 1 year ago)
- Topics: bbs, forum, reddit, rust, twitter
- Language: Rust
- Homepage: https://freedit.eu
- Size: 1.05 MB
- Stars: 222
- Watchers: 7
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# freedit
[](https://github.com/freedit-org/freedit/actions/workflows/ci.yml)
[](https://github.com/freedit-org/freedit/actions/workflows/release.yml)
[](https://github.com/freedit-org/freedit/releases)
[](https://freedit-org.github.io/freedit/freedit/index.html)
[](https://github.com/freedit-org/freedit/blob/main/LICENSE)
The safest and lightest forum, powered by rust.
Demo:
GitHub:
## Features
- **Single-binary deployment** – easy to run with an embedded [fjall](https://docs.rs/fjall/latest/fjall/) database.
- **Works without JavaScript** – fully functional and secure even with JavaScript disabled. ([Why avoiding JavaScript matters](https://thehackernews.com/2022/05/tails-os-users-advised-not-to-use-tor.html))
- **End-to-end encrypted private messages** – only sender and recipient can read.
- **Math & code highlighting** – rich formatting without JavaScript.
- **Markdown support** – write in clean, readable syntax.
- **Inn** – group spaces, like Subreddits.
- **Solo** – personal microblogging, like Twitter.
- **Online RSS reader** – follow and read feeds in one place.
- **Podcast support** – subscribe and listen directly through the platform.
## Usage
### From binary
1. Download freedit binary from [releases](https://github.com/freedit-org/freedit/releases)
2. unzip freedit.zip
3. run `./freedit`, open browser to `addr`,
### From source code
Prerequisition: install [Rust](https://www.rust-lang.org/tools/install)
```bash
git clone https://github.com/freedit-org/freedit
cd freedit && cargo build -r
./target/release/freedit
```
## FAQ
### How to generate podcast srt file?
[whisper](https://github.com/openai/whisper) is used.
* Usage: `whisper ~/podcasts/1.mp3 --word_timestamps True --highlight_words True -f srt`
## Documentation
* online doc:
* generate local documentation:
```bash
cargo doc --no-deps --document-private-items --open
```
## Development
```bash
git clone https://github.com/freedit-org/freedit
cd freedit && cargo run
```
## Credits
* icon:
* CSS framework:
* Rust crates: [Cargo.toml](https://github.com/freedit-org/freedit/blob/main/Cargo.toml)
* Markdown editor: [overtype](https://github.com/panphora/overtype)