Go to file
Niko Abeler 7b047a609f powered by 2024-05-18 22:04:23 +02:00
.github/workflows cleanup + primary color usage 2024-05-18 21:59:32 +02:00
app cleanup + primary color usage 2024-05-18 21:59:32 +02:00
assets micro formats + html from owl 1 2023-07-19 21:03:48 +02:00
cmd/owl cleanup + primary color usage 2024-05-18 21:59:32 +02:00
config WIP copying code from fedi-games 2024-05-13 19:03:24 +02:00
domain/model cleanup + primary color usage 2024-05-18 21:59:32 +02:00
e2e_tests fix test 2024-05-18 20:31:50 +02:00
entry_types Open Graph Meta data 2024-02-24 21:21:48 +01:00
importer full import 2023-07-19 21:03:48 +02:00
infra add follower repository 2024-05-12 21:45:04 +02:00
interactions support announce, publish deletions, add 'hashtags' to notes 2024-05-18 12:42:49 +02:00
plugings unified interface Formable 2024-02-21 20:24:18 +01:00
render powered by 2024-05-18 22:04:23 +02:00
test unified interface Formable 2024-02-21 20:24:18 +01:00
web cleanup + primary color usage 2024-05-18 21:59:32 +02:00
.air.toml WIP mock amsto + tests 2024-05-14 21:23:37 +02:00
.dockerignore WIP mock amsto + tests 2024-05-14 21:23:37 +02:00
.gitignore WIP mock amsto + tests 2024-05-14 21:23:37 +02:00
Dockerfile package updates 2024-05-09 11:13:42 +02:00
README.md CI prep + README 2024-05-18 19:49:55 +02:00
go.mod WIP copying code from fedi-games 2024-05-13 19:03:24 +02:00
go.sum WIP copying code from fedi-games 2024-05-13 19:03:24 +02:00
release.sh WIP release 2023-07-19 21:03:48 +02:00

README.md

Mascot

Owl Blogs

Owl-blogs is a blogging software focused on simplicity with IndieWeb and Fediverse support.

Usage

Run

To run the web server use the command:

owl web

The blog will run on port 3000 (http://localhost:3000)

To create a new account:

owl new-author -u <name> -p <password>

To retrieve a list of all commands run:

owl -h

Development

Build

CGO_ENABLED=1 go build -o owl ./cmd/owl

For development with live reload use air (has to be install first)

Tests

The project has two test suites; "unit tests" written in go and "end-to-end tests" written in python.

Unit Tests

go test ./...

End-to-End tests

  • Start the docker compose setup in the e2e_tests directory.
  • Install the python dependencies into a virtualenv
cd e2e_tests
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
  • Run the e2e_tests with pytest