Mataroa
About this project
Naked blogging platform.
Community
We have a mailing list at ~sirodoht/mataroa-community@lists.sr.ht for the mataroa community to introduce themselves, their blogs, and discuss anything that’s on their mind!
Archives at lists.sr.ht/~sirodoht/mataroa-community
Tools
Contributing
Open a PR on GitHub.
Send an email patch to ~sirodoht/public-inbox@lists.sr.ht. See how to contribute using email patches here: git-send-email.io.
Read our docs at docs.mataroa.blog
Development
This is a Django codebase. Check out the Django docs for general technical documentation.
Structure
The Django project is mataroa. There is one Django app,
main, with all business logic. Application CLI commands are generally
divided into two categories, those under python manage.py and those under
make.
Set up subdomains
Because mataroa works primarily with subdomain, one cannot access the basic web app
using the standard http://127.0.0.1:8000 or http://localhost:8000 URLs. What we do
for local development is adding a few custom entries on our /etc/hosts system file.
Important note: there needs to be an entry of each user account created in the local development environment, so that the web server can respond to it.
The first line is the main needed: mataroalocal.blog. The rest are included as
examples of other users one can create in their local environment. The
easiest way to create them is to go through the sign up page
(http://mataroalocal.blog:8000/accounts/create/ using default values).
# /etc/hosts
127.0.0.1 mataroalocal.blog
127.0.0.1 paul.mataroalocal.blog
127.0.0.1 random.mataroalocal.blog
127.0.0.1 anyusername.mataroalocal.blog
This will enable us to access mataroa locally (once we start the web server) at
http://mataroalocal.blog:8000/
and if we make a user account with username paul, then we will be able to access it at
http://paul.mataroalocal.blog:8000/
Docker
[!NOTE]
This is the last step for initial Docker setup. See the "Environment variables" section below, for further configuration details.
To set up a development environment with Docker and Docker Compose, run the following to start the web server and database:
docker compose up
If you have also configured hosts as described above in the "Set up subdomains" section, mataroa should now be locally accessible at [http://mataroalocal.blog:8000/](http://mataroalocal.blog:80