bloggulus

command module
v0.3.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2024 License: MIT Imports: 16 Imported by: 0

README

bloggulus

Bloggulus is a web application for aggregating and indexing your favorite blogs. I wrote it to serve as a less engaging and more personalized version of sites like Hacker News or Reddit.

Local Development

While the primary Bloggulus website represents my own personal collection of blogs, it is designed to be easily self-hostable. Check out the releases page for pre-built binaries.

Setup

This project depends on Go and NodeJS.

Database

This project uses PostgreSQL for persistent storage. To develop locally, you'll an instance of the database running somehow or another. I find Docker to be a nice tool for this but you can do whatever works best.

The following command starts the necessary containers:

docker compose up -d

These containers can be stopped via:

docker compose down
Running

Run the backend API and frontend SPA at the same time:

make -j run
Testing

Tests can be ran after starting the necessary containers:

make test

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
backend
web
web/api/validator
Input validation helper based on Alex Edwards' package from Let's Go Further
Input validation helper based on Alex Edwards' package from Let's Go Further

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL