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

polish README closes #158 #178

Merged
simon merged 7 commits from feature/#158-polish-README into main 2025-10-16 12:05:42 +02:00
Conversation 2 Commits 7 Files changed 2 +5 -5
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 30c3943884 - Show all commits

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.
* **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.
simon marked this conversation as resolved Outdated
rafael commented 2025-10-16 11:35:37 +02:00
Outdated
Copy link

I'm not sure if everyone reading this will know what "Custom fields" means. Maybe we could say something like

Customize what data you collect about members

or

Customizable forms: only collect the member data you truly need

I'm not sure if everyone reading this will know what "Custom fields" means. Maybe we could say something like > Customize what data you collect about members or > Customizable forms: only collect the member data you truly need
* **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.**
@ -106,8 +106,8 @@ cd mila
asdf install
# Inside the repo folder:
mix local.hex 2.1.1
mix archive.install hex phx_new 1.7.20
mix local.hex
mix archive.install hex phx_new
simon marked this conversation as resolved Outdated
moritz commented 2025-10-09 12:35:53 +02:00
Outdated
Copy link

We use phoenix 1.8 now

We use phoenix 1.8 now
rafael commented 2025-10-16 11:45:24 +02:00
Outdated
Copy link

I think we could even leave out the versions here completely and just assume the newest version of hex should work 🤔

I think we could even leave out the versions here completely and just assume the newest version of hex should work 🤔
```
> 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
- **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework
- **Frontend:** Phoenix LiveView + TailwindCSS + Heroicons
- **Backend:** Elixir, Phoenix, LiveView, Ash Framework
simon marked this conversation as resolved Outdated
rafael commented 2025-10-16 11:42:50 +02:00
Outdated
Copy link

I think we could leave out the versions here, they don't add much relevant information and will become outdated quickly.

I think we could leave out the versions here, they don't add much relevant information and will become outdated quickly.
- **Frontend:** Phoenix LiveView + DaisyUI + Heroicons
simon marked this conversation as resolved Outdated
rafael commented 2025-10-16 11:42:21 +02:00
Outdated
Copy link

I'd say DaisyUI instead of tailwind here, it's what you'll typically interact with most as a developer :)

I'd say DaisyUI instead of tailwind here, it's what you'll typically interact with most as a developer :)
- **Database:** PostgreSQL (via AshPostgres)
- **Auth:** AshAuthentication (OIDC + password strategy)
- **Mail:** Swoosh