From d1e5856db8038ff06ecb21e347c792f86b9f64b4 Mon Sep 17 00:00:00 2001 From: Carlo <138704619+wan0v@users.noreply.github.com> Date: Wed, 17 Jun 2026 23:58:59 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 76 +++++++++++++++++++------------------------------------ 1 file changed, 26 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 5f300780..d8014fed 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,34 @@ -# [Project Name] +

+ logo +

+

AllesLocker

-> **[One-sentence value proposition / elevator pitch]** +Alles Locker is a web-based access management system. It lets you manage electronic locks, assign access rights to persons, and integrate with implemented third-party lock vendors β€” all from a single dashboard. The architecture enables easy integration of additional vendors. -[Badges Placeholder: Build | License | Docker | Version] +

+ logo +

---- +## Architecture -## πŸ“– Overview -[Briefly describe the business problem being solved] -[Briefly describe the technical solution and its primary goal] +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Frontend │────▢│ Backend │────▢│ MariaDB β”‚ +β”‚ :5173 β”‚ β”‚ :8080 β”‚ β”‚ :3306 β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ Vendor β”‚ + β”‚ APIs β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` -## ✨ Key Features -* **[Feature 1]:** [Short description of core functionality] -* **[Feature 2]:** [Short description of hardware abstraction] -* **[Feature 3]:** [Short description of administrative capabilities] -* **[Feature 4]:** [Short description of security/audit features] +## Getting Started -## πŸ— Technical Architecture -[High-level explanation of Clean Architecture and design principles] +For further information, please visit the [wiki](https://github.com/AllesLockr/Backend/wiki). -* **Language:** [Primary programming language] -* **Framework:** [Main application framework] -* **Architecture Style:** [e.g., Clean Architecture / Hexagonal] -* **Database:** [Type of SQL database and migration tool] -* **Artifact Registry:** [Container registry details] +## Repositories -## πŸš€ Development -### Prerequisites -* [Tool/Dependency 1] -* [Tool/Dependency 2] - -### Getting Started -1. [Steps for cloning the repository] -2. [Steps for initializing local infrastructure] -3. [Steps for running the application in development mode] - -## 🀝 Contributing -We welcome contributions! To ensure that all additions align with our Clean Architecture standards and Kotlin coding conventions, please review our detailed guidelines in the **CONTRIBUTING.md** file. - -The contributing guide covers: -* Code style and linting rules -* The process for adding new hardware adapters -* Testing requirements (Unit & Integration) -* Pull Request and Review workflows - -## πŸ”’ Security & License -* **Security Policy:** [Description of security measures and reporting vulnerabilities] -* **License:** This project is licensed under the **GNU AGPLv3**. -* **Project Status:** [Note regarding the academic nature of the project and liability disclaimer] - -## πŸ‘₯ The Team -* **[Name 1]** (@[github-handle]) - [Core Responsibilities] -* **[Name 2]** (@[github-handle]) - [Core Responsibilities] -* **[Name 3]** (@[github-handle]) - [Core Responsibilities] - ---- -*[University/Institution Name] β€” Bachelor Project [Year]* \ No newline at end of file +- [Frontend](https://github.com/alleslockr/alleslocker-frontend) +- [Backend](https://github.com/alleslockr/alleslocker-backend) From ec5b83e55d9bc58660aa64ce343afca3a09200ca Mon Sep 17 00:00:00 2001 From: Carlo <138704619+wan0v@users.noreply.github.com> Date: Thu, 18 Jun 2026 00:04:25 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d8014fed..e0e9822f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

AllesLocker

-Alles Locker is a web-based access management system. It lets you manage electronic locks, assign access rights to persons, and integrate with implemented third-party lock vendors β€” all from a single dashboard. The architecture enables easy integration of additional vendors. +AllesLocker is a web-based access management system. It lets you manage electronic locks, assign access rights to persons, and integrate with implemented third-party lock vendors β€” all from a single dashboard. The architecture enables easy integration of additional vendors.

logo @@ -30,5 +30,5 @@ For further information, please visit the [wiki](https://github.com/AllesLockr/B ## Repositories -- [Frontend](https://github.com/alleslockr/alleslocker-frontend) -- [Backend](https://github.com/alleslockr/alleslocker-backend) +- [Frontend](https://github.com/AllesLockr/Frontend) +- [Backend](https://github.com/AllesLockr/Backend) From 3972c120a8d329d04a410f38800f09b2fa169310 Mon Sep 17 00:00:00 2001 From: Carlo <138704619+wan0v@users.noreply.github.com> Date: Thu, 18 Jun 2026 00:15:02 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e0e9822f..d3e7cc4f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -

+

logo -

-

AllesLocker

+

AllesLocker

+
AllesLocker is a web-based access management system. It lets you manage electronic locks, assign access rights to persons, and integrate with implemented third-party lock vendors β€” all from a single dashboard. The architecture enables easy integration of additional vendors.