Skip to content
/ chan Public

🍀 a simple "chan"-like board written in rust.

License

Notifications You must be signed in to change notification settings

Fuwn/chan

Repository files navigation

chan

A simple "chan"-like board written in Rust.

GitHub Issues License GitHub Stars

⣿⣿⣷⡁⢆⠈⠕⢕⢂⢕⢂⢕⢂⢔⢂⢕⢄⠂⣂⠂⠆⢂⢕⢂⢕⢂⢕⢂⢕⢂
⣿⣿⣿⡷⠊⡢⡹⣦⡑⢂⢕⢂⢕⢂⢕⢂⠕⠔⠌⠝⠛⠶⠶⢶⣦⣄⢂⢕⢂⢕
⣿⣿⠏⣠⣾⣦⡐⢌⢿⣷⣦⣅⡑⠕⠡⠐⢿⠿⣛⠟⠛⠛⠛⠛⠡⢷⡈⢂⢕⢂
⠟⣡⣾⣿⣿⣿⣿⣦⣑⠝⢿⣿⣿⣿⣿⣿⡵⢁⣤⣶⣶⣿⢿⢿⢿⡟⢻⣤⢑⢂
⣾⣿⣿⡿⢟⣛⣻⣿⣿⣿⣦⣬⣙⣻⣿⣿⣷⣿⣿⢟⢝⢕⢕⢕⢕⢽⣿⣿⣷⣔
⣿⣿⠵⠚⠉⢀⣀⣀⣈⣿⣿⣿⣿⣿⣿⣿⣿⣿⣗⢕⢕⢕⢕⢕⢕⣽⣿⣿⣿⣿
⢷⣂⣠⣴⣾⡿⡿⡻⡻⣿⣿⣴⣿⣿⣿⣿⣿⣿⣷⣵⣵⣵⣷⣿⣿⣿⣿⣿⣿⡿
⢌⠻⣿⡿⡫⡪⡪⡪⡪⣺⣿⣿⣿⣿⣿⠿⠿⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠃
⠣⡁⠹⡪⡪⡪⡪⣪⣾⣿⣿⣿⣿⠋⠐⢉⢍⢄⢌⠻⣿⣿⣿⣿⣿⣿⣿⣿⠏⠈
⡣⡘⢄⠙⣾⣾⣾⣿⣿⣿⣿⣿⣿⡀⢐⢕⢕⢕⢕⢕⡘⣿⣿⣿⣿⣿⣿⠏⠠⠈
⠌⢊⢂⢣⠹⣿⣿⣿⣿⣿⣿⣿⣿⣧⢐⢕⢕⢕⢕⢕⢅⣿⣿⣿⣿⡿⢋⢜⠠⠈
⠄⠁⠕⢝⡢⠈⠻⣿⣿⣿⣿⣿⣿⣿⣷⣕⣑⣑⣑⣵⣿⣿⣿⡿⢋⢔⢕⣿⠠⠈
⠨⡂⡀⢑⢕⡅⠂⠄⠉⠛⠻⠿⢿⣿⣿⣿⣿⣿⣿⣿⣿⡿⢋⢔⢕⢕⣿⣿⠠⠈
⠄⠪⣂⠁⢕⠆⠄⠂⠄⠁⡀⠂⡀⠄⢈⠉⢍⢛⢛⢛⢋⢔⢕⢕⢕⣽⣿⣿⠠⠈

Inspirational

Originally, this project was supposed to be a public OpenPGP 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.
  2. Clone the repository.
  3. Rename the 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 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