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

docs: reduce horizontal lines

Browse source
This commit is contained in:
Simon 2025-10-02 15:26:23 +02:00
parent 9f8b412d23
commit 2f74ec8ccb
Signed by: simon
GPG key ID: 40E7A58C4AA1EDB2
1 changed files with 0 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -5,22 +5,16 @@
[![CI Status](https://img.shields.io/badge/build-pending-lightgrey.svg)](link-to-ci) [![CI Status](https://img.shields.io/badge/build-pending-lightgrey.svg)](link-to-ci)
![License](https://img.shields.io/badge/license-TBD-blue) ![License](https://img.shields.io/badge/license-TBD-blue)
---
## 🚧 Project Status ## 🚧 Project Status
⚠️ **Early development** — not production-ready. Expect breaking changes. ⚠️ **Early development** — not production-ready. Expect breaking changes.
Contributions and feedback are welcome! Contributions and feedback are welcome!
---
## ✨ Overview ## ✨ Overview
Mila is a free and open-source membership management tool designed for real club needs. Mila is a free and open-source membership management tool designed for real club needs.
It is **self-hosting friendly**, aims for **accessibility and GDPR compliance**, and focuses on **usability** instead of feature overload. It is **self-hosting friendly**, aims for **accessibility and GDPR compliance**, and focuses on **usability** instead of feature overload.
---
## 💡 Why Mila? ## 💡 Why Mila?
Most membership tools for clubs are either: Most membership tools for clubs are either:
@ -38,15 +32,11 @@ Most membership tools for clubs are either:
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.**
---
## 📸 Screenshots ## 📸 Screenshots
![Screenshot placeholder](docs/images/screenshot.png) ![Screenshot placeholder](docs/images/screenshot.png)
*This is how Mila might look in action.* *This is how Mila might look in action.*
---
## 🔑 Features ## 🔑 Features
- ✅ Manage member data with ease - ✅ Manage member data with ease
@ -60,8 +50,6 @@ Our philosophy: **software should help people spend less time on administration
- 🚧 Accessibility, GDPR, usability improvements - 🚧 Accessibility, GDPR, usability improvements
- 🚧 Email sending - 🚧 Email sending
---
## 🚀 Quick Start (Development) ## 🚀 Quick Start (Development)
### Prerequisites ### Prerequisites
@ -125,8 +113,6 @@ mix archive.install hex phx_new 1.7.20
> Note: running `mix local.hex` must be done inside the repo folder, > Note: running `mix local.hex` must be done inside the repo folder,
> because `.tool-versions` defines the Erlang/Elixir versions. > because `.tool-versions` defines the Erlang/Elixir versions.
---
### Run the app ### Run the app
1. Copy env file: 1. Copy env file:
@ -145,8 +131,6 @@ mix archive.install hex phx_new 1.7.20
- Mail UI: <http://localhost:1080> - Mail UI: <http://localhost:1080>
- Postgres: `localhost:5000` - Postgres: `localhost:5000`
---
## 🔐 Testing SSO locally ## 🔐 Testing SSO locally
Mila uses OIDC for Single Sign-On. In development, a local **Rauthy** instance is provided. Mila uses OIDC for Single Sign-On. In development, a local **Rauthy** instance is provided.
@ -165,8 +149,6 @@ Mila uses OIDC for Single Sign-On. In development, a local **Rauthy** instance i
Now you can log in to Mila via OIDC! Now you can log in to Mila via OIDC!
---
## ⚙️ Configuration ## ⚙️ Configuration
- **Env vars:** see `.env.example` - **Env vars:** see `.env.example`
@ -177,8 +159,6 @@ Now you can log in to Mila via OIDC!
- User/pass: `postgres` / `postgres` - User/pass: `postgres` / `postgres`
- DB: `mila_dev` - DB: `mila_dev`
---
## 🏗️ Architecture ## 🏗️ Architecture
- **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework - **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework
@ -193,8 +173,6 @@ Code structure:
- `lib/mv_web/` — Phoenix controllers, LiveViews, components - `lib/mv_web/` — Phoenix controllers, LiveViews, components
- `assets/` — frontend assets (Tailwind, JS, etc.) - `assets/` — frontend assets (Tailwind, JS, etc.)
---
## 🧑‍💻 Development ## 🧑‍💻 Development
Useful `just` commands: Useful `just` commands:
@ -205,8 +183,6 @@ Useful `just` commands:
- `just reset-database` — reset local DB - `just reset-database` — reset local DB
- `just regen-migrations <name>` — regenerate migrations - `just regen-migrations <name>` — regenerate migrations
---
## 📦 Deployment ## 📦 Deployment
A production release image is built via the provided `Dockerfile`. A production release image is built via the provided `Dockerfile`.
@ -214,8 +190,6 @@ Entrypoint: `/app/bin/server`.
More detailed deployment docs are planned. More detailed deployment docs are planned.
---
## 🤝 Contributing ## 🤝 Contributing
We welcome contributions! We welcome contributions!
@ -223,18 +197,12 @@ We welcome contributions!
- Please follow existing code style and conventions. - Please follow existing code style and conventions.
- Expect breaking changes while the project is in early development. - Expect breaking changes while the project is in early development.
---
## 📄 License ## 📄 License
**License: TBD** (Free and Open Source). **License: TBD** (Free and Open Source).
A proper license file will be added soon. A proper license file will be added soon.
---
## 📬 Contact ## 📬 Contact
- Issues: [GitLab Issues](https://git.local-it.org/local-it/mitgliederverwaltung/-/issues) - Issues: [GitLab Issues](https://git.local-it.org/local-it/mitgliederverwaltung/-/issues)
- Community links: coming soon. - Community links: coming soon.
---