emmeline.girlkisser.top / beep
a mini social media app for small communities
fork atom
beep / doc / database_spec.md
at 2cf50a5c53fd1072b4a4eb656a10e4d41d3695c4 3.0 kB view raw view code

database spec#

i have a mental map of the databases in use for beep, but that does not mean others also do. along with that, having a visual representation is probably going to be pretty useful. so with that said, i present to you, the database spec for beep:

User#

represents a registered user

name type desc
id int identifier this user on the backend
username string identifier this user on the frontend
nickname ?string optional nickname for this user on the frontend
password string hashed and salted password for this user
password_salt string salt for this user's password
muted bool controls whether or not this user can make posts
admin bool controls whether or not this user is an admin
theme ?string controls per-user css themes
bio string bio for this user
pronouns string pronouns for this user
created_at time.Time a timestamp of when this user was made

Post#

represents a public post

name type desc
id int identifier for this post
author_id int id of the user that authored this post
title string the title of this post
body string the body of this post
posted_at time.Time a timestamp of when this post was made

Like#

represents all likes and dislikes on posts for this beep instance

name type desc
id int identifier for this (dis)like
user_id int the user that sent this (dis)like
post_id int the post this (dis)like is for
is_like bool true if this is a like, false if a dislike

LikeCache#

stores total likes for a post

name type desc
id int identifier for this entry
post_id int the post this entry is for
likes int the net amount of likes this post has