servala/servala-portal
3
0
Fork 0
Code Issues 21 Pull requests 1 Projects 1 Releases Packages 2 Activity Actions
The Servala Self-Service Portal
113 commits 3 branches 1 tag 3.9 MiB
Find a file
Tobias Brunner e56447ece6
dont include local sqlite file in docker build
2025-03-21 14:24:21 +01:00
.forgejo deployment automation for staging 2025-03-21 14:24:21 +01:00
deployment/kustomize deployment automation for staging 2025-03-21 14:24:21 +01:00
docker Docker: Provide working directory for gunicorn 2025-03-07 15:57:49 +01:00
docs move over documentation from old place 2025-03-11 15:37:13 +01:00
src Profile view permissions 2025-03-21 09:52:53 +01:00
.dockerignore dont include local sqlite file in docker build 2025-03-21 14:24:21 +01:00
.env.example Add auth configuration to .env and settings.py 2025-03-16 10:33:34 +01:00
.gitignore deployment automation for staging 2025-03-21 14:24:21 +01:00
.pre-commit-config.yaml add a pre-commit configuration 2025-03-07 09:21:48 +01:00
.python-version uv + Django[postgres] installation 2025-03-05 10:44:16 +01:00
Dockerfile initialize docker build 2025-03-07 09:16:24 +01:00
LICENSE Initial commit 2025-03-03 15:26:47 +00:00
Makefile initial Antora boilerplate 2025-03-10 09:23:18 +01:00
playbook.yml initial Antora boilerplate 2025-03-10 09:23:18 +01:00
pyproject.toml Add django-rules 2025-03-20 15:36:40 +01:00
README.md deployment automation for staging 2025-03-21 14:24:21 +01:00
uv.lock Add django-rules 2025-03-20 15:36:40 +01:00

README.md

Servala Portal

Servala Logo

The Servala Self-Service Portal

Documentation

Available at https://docs.servala.com/.

The project documentation is written in AsciiDoc and built with Antora. It's automatically packaged and deployed by the CI/CD pipeline found in .forgejo/workflows/docs.yaml.

Paths:

  • docs/modules/ROOT/pages: Documentation pages
  • docs/modules/ROOT/assets/images: Images to be included in the documentation pages
  • docs/modules/ROOT/nav.adoc: Site navigation (new pages need to be added there)

Writing documentation is best done by running make docs-preview and connecting to the site at http://localhost:2020/. The browser add-on LiveReload - Web extension will help while editing with automated page reload in the browser.

Development setup

First, copy the .env.example file to .env and adjust the settings to your needs. Make sure to source the file before running any commands.

Then use uv to install the project and run its commands while you’re developing:

uv sync --dev
uv run src/manage.py migrate
uv run src/manage.py runserver

This will start the development server on http://localhost:8000.

Configuration

TODO

Code style and linting

Servala uses several linters / formatters to keep the project style consistent for you. Run them like this:

uv run black src/  # Code formatting; -c to just check
uv run isort src/  # Import ordering; -c to just check
uv run djlint src/ --reformat --format-js --format-css  # Format templates, JS and CSS, --check to just check
uv run flake8 src/  # Python linter

The repository features a pre-commit configuration which helps to properly format the source code before committing. It's recommended to install and use it.

Docker

The project provides a Dockerfile which builds a production-ready container image. It uses Caddy to serve static files and connect to Gunicorn, the Python WSGI application server.

Building:

docker build -t local/servala-portal .

Running:

docker run --rm -ti -p 8080:8080 --name=servala-portal --rm --env-file .env local/servala-portal

TODO: Persistence

Deployment

TODO

Testing

TODO