Skip to content

pcklsft/brd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

brd

A simple imageboard site that supports private walled-garden communication

Setup

Install sqlx-cli if you haven't already

cargo install sqlx-cli --no-default-features --features native-tls,postgres

Declare the database URL (you can add this to a .env file at the working directory)

export DATABASE_URL="postgres://<your postgres user>:<your password>@localhost/brd"

Create the database

sqlx db create

Run sql migrations

sqlx migrate run

I had to learn how to set up a postgres thing for this and it was actual hell.

Usage

cargo run

Goals

  • The imageboard should be dead simple with as little clutter as possible
  • It should have high configurability, including per-board configurability (for things like max file-size, allowed filetypes, etc)
  • Simple-ish extensibility -> should be moddable and have other packages/features that are toggleable

Notes on configurability

Some users of this software may not want signups enabled (just anonymouse posts), or may want open signups (signups without a key).

Simple todo

Boilerplate

  • sqlx setup

Imageboard

  • Require an image to create a post, with optional text content.
  • Top-level post on thread requires text
  • CRUD threads & posts

Validation

  • All user-submitted content is properly validated
  • Namely, users and threads/posts

Site

  • Homepage (see all boards)
  • Boards page (see all posts in board)
  • Post page (see all replies to post & post)
  • User page (see user and last posts/replies)
  • Users page (see all users)

Users

  • OPTIONAL feature (off by default, only admin users are on by default & cannot be turned off)
  • Signup to create user (with key?)
  • Login to post & view posts
  • Only "admin user" can execute admin api

Admin utilities

  • CRUD boards
  • Moderation tools (for posts & users)

About

simple & easily configurable image board site

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •