https://github.com/fuwn/chan
🍀 a simple "chan"-like board written in rust.
https://github.com/fuwn/chan
4chan board chan channel database forum rust rust-lang
Last synced: 3 months ago
JSON representation
🍀 a simple "chan"-like board written in rust.
- Host: GitHub
- URL: https://github.com/fuwn/chan
- Owner: Fuwn
- License: agpl-3.0
- Created: 2020-11-19T05:13:04.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-04T11:26:13.000Z (4 months ago)
- Last Synced: 2025-06-30T23:53:12.633Z (3 months ago)
- Topics: 4chan, board, chan, channel, database, forum, rust, rust-lang
- Language: Handlebars
- Homepage:
- Size: 227 KB
- Stars: 21
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chan
A simple "chan"-like board written in Rust.
[](https://github.com/fuwn/chan/issues)
[](LICENSE)
```
⣿⣿⣷⡁⢆⠈⠕⢕⢂⢕⢂⢕⢂⢔⢂⢕⢄⠂⣂⠂⠆⢂⢕⢂⢕⢂⢕⢂⢕⢂
⣿⣿⣿⡷⠊⡢⡹⣦⡑⢂⢕⢂⢕⢂⢕⢂⠕⠔⠌⠝⠛⠶⠶⢶⣦⣄⢂⢕⢂⢕
⣿⣿⠏⣠⣾⣦⡐⢌⢿⣷⣦⣅⡑⠕⠡⠐⢿⠿⣛⠟⠛⠛⠛⠛⠡⢷⡈⢂⢕⢂
⠟⣡⣾⣿⣿⣿⣿⣦⣑⠝⢿⣿⣿⣿⣿⣿⡵⢁⣤⣶⣶⣿⢿⢿⢿⡟⢻⣤⢑⢂
⣾⣿⣿⡿⢟⣛⣻⣿⣿⣿⣦⣬⣙⣻⣿⣿⣷⣿⣿⢟⢝⢕⢕⢕⢕⢽⣿⣿⣷⣔
⣿⣿⠵⠚⠉⢀⣀⣀⣈⣿⣿⣿⣿⣿⣿⣿⣿⣿⣗⢕⢕⢕⢕⢕⢕⣽⣿⣿⣿⣿
⢷⣂⣠⣴⣾⡿⡿⡻⡻⣿⣿⣴⣿⣿⣿⣿⣿⣿⣷⣵⣵⣵⣷⣿⣿⣿⣿⣿⣿⡿
⢌⠻⣿⡿⡫⡪⡪⡪⡪⣺⣿⣿⣿⣿⣿⠿⠿⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠃
⠣⡁⠹⡪⡪⡪⡪⣪⣾⣿⣿⣿⣿⠋⠐⢉⢍⢄⢌⠻⣿⣿⣿⣿⣿⣿⣿⣿⠏⠈
⡣⡘⢄⠙⣾⣾⣾⣿⣿⣿⣿⣿⣿⡀⢐⢕⢕⢕⢕⢕⡘⣿⣿⣿⣿⣿⣿⠏⠠⠈
⠌⢊⢂⢣⠹⣿⣿⣿⣿⣿⣿⣿⣿⣧⢐⢕⢕⢕⢕⢕⢅⣿⣿⣿⣿⡿⢋⢜⠠⠈
⠄⠁⠕⢝⡢⠈⠻⣿⣿⣿⣿⣿⣿⣿⣷⣕⣑⣑⣑⣵⣿⣿⣿⡿⢋⢔⢕⣿⠠⠈
⠨⡂⡀⢑⢕⡅⠂⠄⠉⠛⠻⠿⢿⣿⣿⣿⣿⣿⣿⣿⣿⡿⢋⢔⢕⢕⣿⣿⠠⠈
⠄⠪⣂⠁⢕⠆⠄⠂⠄⠁⡀⠂⡀⠄⢈⠉⢍⢛⢛⢛⢋⢔⢕⢕⢕⣽⣿⣿⠠⠈
```
## Inspirational
Originally, this project was supposed to be a public [OpenPGP](https://www.openpgp.org/) key server
because I was frustrated with the current selection of key servers, but I randomly had the idea to
make a "chan"-like forum and I had this sitting around so I made this!
## Limitations
At the moment, the board is missing automatic post pruning and moderation features, but I have plans
to finish adding them in the near future. As well, at the moment, there has to be a 'empty' thread
entry in the 'threads' table within the database, for now. This is because of the way that the
thread making feature grabs valid board data. I'll probably fix this sometime soon also.
Ignore my messy Handlebars templates, I didn't really have a purpose to make them fancy or whatever
because of the simplicity of the project.
## Usage
1. Install [Rust](https://www.rust-lang.org/).
2. Clone the repository.
3. Rename the [`chan.db.example`](./chan.db.example) file to `chan.db`.
4. `$ cargo run`.
### Adding boards
To add boards, open the example database in a SQLite viewer add a board entry to the 'boards' table
(examples provided in database).
Pre-built binaries *might* be available in the future if there is enough demand for them.
### Usage Notes
[`chan.db.example`](./chan.db.example) is the default format of the database. If you ever want to
"restore" the database to its default state, I recommend you keep a copy of the original state of
this file.
In the future, I will *most likely* add a `setup_db()` function to validate the database state and
properly setup the database when an invalid format is found.
## Contribution
Feel free to make pull requests or open issues if you think a feature should be added or you find a
bug, or just anything -- within reason.
### License
[GNU Affero General Public License v3.0](https://github.com/fuwn/chan/blob/main/LICENSE.md)