local-it/mitgliederverwaltung
2
3
Fork 0
Code Issues 51 Pull requests 13 Projects 1 Releases Packages 1 Activity Actions

docs: polish Readme

Browse source
This commit is contained in:
Simon 2025-10-16 11:59:21 +02:00
parent 30616d5a8d
commit b9503da2c3
Signed by: simon
GPG key ID: 40E7A58C4AA1EDB2
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -27,7 +27,7 @@ Most membership tools for clubs are either:
* **Simple**: Focused on what clubs really need — members, dues, communication. * **Simple**: Focused on what clubs really need — members, dues, communication.
* **Usable**: Clean, accessible UI, GDPR-compliant, designed with everyday volunteers in mind. * **Usable**: Clean, accessible UI, GDPR-compliant, designed with everyday volunteers in mind.
* **Flexible**: Custom fields, role-based permissions, and self-service for members. * **Flexible**: Customize what data you collect about members, role-based permissions, and self-service for members.
* **Truly open**: 100% free and open source — no lock-in, transparent code, self-host friendly. * **Truly open**: 100% free and open source — no lock-in, transparent code, self-host friendly.
Our philosophy: **software should help people spend less time on administration and more time on their community.** Our philosophy: **software should help people spend less time on administration and more time on their community.**
@ -106,8 +106,8 @@ cd mila
asdf install asdf install
# Inside the repo folder: # Inside the repo folder:
mix local.hex 2.1.1 mix local.hex
mix archive.install hex phx_new 1.7.20 mix archive.install hex phx_new
``` ```
> Note: running `mix local.hex` must be done inside the repo folder, > Note: running `mix local.hex` must be done inside the repo folder,
@ -161,8 +161,8 @@ Now you can log in to Mila via OIDC!
## 🏗️ Architecture ## 🏗️ Architecture
- **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework - **Backend:** Elixir, Phoenix, LiveView, Ash Framework
- **Frontend:** Phoenix LiveView + TailwindCSS + Heroicons - **Frontend:** Phoenix LiveView + DaisyUI + Heroicons
- **Database:** PostgreSQL (via AshPostgres) - **Database:** PostgreSQL (via AshPostgres)
- **Auth:** AshAuthentication (OIDC + password strategy) - **Auth:** AshAuthentication (OIDC + password strategy)
- **Mail:** Swoosh - **Mail:** Swoosh