Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 2.98 KB

README.md

File metadata and controls

103 lines (74 loc) · 2.98 KB
Raw

Fahrzeugverwaltung 🚗📅

Fahrzeugverwaltung is a comprehensive vehicle management system designed to streamline vehicle reservations and administrative workflows. Built with ASP.NET 8 and Angular, this application ensures efficient vehicle utilization, approval processes, and user notifications.

🌟 Features

Vehicle Reservation

  • 🚗 Reserve Vehicles: Book a vehicle for a specific timespan.
  • ⏳ Customizable Restrictions:
    • Minimum/maximum reservation duration.
    • Minimum/maximum amount of days in advance for reservations.
    • Prevent overlapping reservations.

Approval Process

  • ✔️ Reservation Approval: Admins or designated groups can accept or decline reservation requests.
  • 🔔 Email Alerts: Receive notifications for new reservations and status changes.

User Invitations

  • 📄 Invite New Users:
    • Send an all-in-one PDF document containing the reservation code, instructions (Anleitung), QR code, and more for easy onboarding.

Mail Settings

  • ⚙️ Customize Notifications:
    • Change settings to receive emails only from selected organizations.

📈 Roadmap

  • 📱 Mobile-App: Make the frontend a PWA
  • 🔔 Advanced Notifications: SignalR-Messaging to the frontend and the PWA
  • 📊 Statistics: Provide usage-statistics and trends for administrators
  • 🛠 Setup: Guide the user through the setup process

These features will be implemented after I complete my bachelor thesis. In my thesis I am evaluating event-driven microservice-architecture using the RabbitMQ Eventbroker. Checkout the "BA" branch!

⚙️ Technologies & Tools

Backend

  • ASP.NET 8: Core API development framework.
  • FastEndpoints: High-performance, RESTful endpoint creation.
  • Entity Framework Core: Seamless database operations.
  • MassTransit: Streamlined asynchronous messaging.
  • Swagger: Interactive API documentation and testing.
  • QuestPDF: Generate professional PDF documents for user invitations.

Frontend

  • Angular: Clean, user-friendly interface.
  • Client Code Generation: Automatically generate Angular services for backend integration.

Infrastructure

  • Docker: Containerization for easy deployment and scalability.

🚀 Getting Started

Prerequisites

  • .NET 8 SDK
  • Node.js (v16+)
  • Docker

Infrastructure Setup

  1. Execute the docker file which sets up:
  • MySQL Database
  • Keycloak
cd docker
docker compose up -d

Backend Setup

  1. Navigate to the backend directory: 
    cd .\Backend
  2. Build the Docker image: 
    docker build -t fahrzeugverwaltung-backend .

Frontend Setup

  1. Navigate to the frontend directory:

    cd ../Frontend

  2. Build the docker image:

    docker build -t fahrzeugverwaltung-frontend .

🤝 Contributions

Contributions and suggestions are welcome! Please use the GitHub issue tracker to report bugs or request features.