Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theandrew168/bloggulus
A collective index of my favorite blogs
https://github.com/theandrew168/bloggulus
blogging golang postgresql rss
Last synced: 2 months ago
JSON representation
A collective index of my favorite blogs
- Host: GitHub
- URL: https://github.com/theandrew168/bloggulus
- Owner: theandrew168
- License: mit
- Created: 2020-09-01T15:52:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T04:56:27.000Z (3 months ago)
- Last Synced: 2024-09-18T07:27:29.472Z (3 months ago)
- Topics: blogging, golang, postgresql, rss
- Language: Go
- Homepage: https://bloggulus.com
- Size: 2.46 MB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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](https://bloggulus.com) represents my own personal collection of blogs, it is designed to be easily self-hostable.
Check out the [releases page](https://github.com/theandrew168/bloggulus/releases) for pre-built binaries.
### Setup
This project depends on the [Go](https://golang.org/dl/) programming language.
### Database
This project uses [PostgreSQL](https://www.postgresql.org/) for persistent storage.
To develop locally, you'll an instance of the database running somehow or another.
I find [Docker](https://www.docker.com/) to be a nice tool for this but you can do whatever works best.
The following command starts the necessary containers:
```bash
docker compose up -d
```
These containers can be stopped via:
```bash
docker compose down
```
### Running
Run the application (with automatic restarts via [wgo](https://github.com/bokwoon95/wgo)):
```bash
make run
```
### OAuth Services
For authentication, this project relies on OAuth social sign ins (from GitHub and Google).
To work on the auth system, you'll need to create a `bloggulus.local.conf` file that contains the necessary OAuth credentials (client ID and client secret for each service).
If you need these credentials, feel free to reach out.
Then, you can run the app using the local config file with:
```bash
make run-local
```
Otherwise, you can simply run the application normally (without OAuth configured) and use the local-only debug sign in.
This is enabled when `ENABLE_DEBUG_AUTH` is set (which the already Makefile includes for `run` and `run-local`).
### Testing
Tests can be ran after starting the necessary containers:
```bash
make test
```