Apartment Meters

Modern utility meter management system for apartment buildings with user-friendly interface and reliable backend.

📋 Project Description

Apartment Meters is a full-featured system for managing utility meters in apartment buildings. The application allows residents to easily submit water meter readings, while administrators can monitor resource consumption and manage user accounts.

Key Features

• 🔐 Authentication — secure login system
• 📊 Meter Reading Management — submission, storage, and tracking of readings
• 👤 User Management — creation and editing of user profiles
• 📱 Responsive Interface — works on mobile devices and desktops

🛠️ Technology Stack

Frontend

• React — JavaScript library for building user interfaces
• TypeScript — strongly typed programming language

Backend

• ASP.NET Core — cross-platform framework for building modern APIs
• Entity Framework Core — ORM for database operations
• PostgreSQL — open-source relational database
• JWT Authentication — secure authentication and authorization
• AutoMapper — object mapping
• FluentValidation — input validation

Infrastructure

• Docker — application containerization
• GitHub Actions — CI/CD processes
• xUnit — unit testing
• Swagger — API documentation

🏗️ Architecture

The project is built using clean architecture principles:

API/
├── apartment-meters.API           # Presentation layer (Controllers, Middleware)
├── apartment-meters.Application   # Application layer (Use Cases, DTOs, Validators)
├── apartment-meters.Domain        # Domain layer (Entities, Repositories interfaces)
├── apartment-meters.Infrastructure# Infrastructure layer (External services)
├── apartment-meters.Persistence   # Data access layer (EF Core, Repositories)
└── apartment-meters.Tests         # Unit and integration tests

🚀 Getting Started

Prerequisites

• Docker
• Docker Compose
• .NET SDK 8.0 (for local development)
• Node.js version 18+ (for local development)

Running with Docker (recommended)

1. Clone the repository:

   git clone https://github.com/vladkozhuhov/apartment-meters.git
   cd apartment-meters
   

2. Start the application using Docker Compose:

   docker-compose up
   

Local Development Setup

Backend

1. Navigate to the API directory:

   cd apartment-meters/API
   

2. Restore dependencies and run the project:

   dotnet restore
   dotnet run --project apartment-meters.API
   

Frontend

1. Navigate to the UI directory:

   cd apartment-meters/UI
   

2. Install dependencies and start the application:

   npm install
   npm start
   

👨‍💻 For Developers

Branching Strategy

• main — main branch containing stable release code
• develop — development branch containing code for the next release

Creating New Features

1. Create a new branch from develop:

   git checkout develop
   git pull
   git checkout -b feature/my-feature
   

2. Implement the feature and create a pull request to develop

CI/CD

The project uses GitHub Actions for automation:

• CI Pipeline (.github/workflows/ci.yml) — runs on every push and PR

  • Building the project
  • Running tests
  • Code quality checks

• CD Pipeline (.github/workflows/cd.yml) — runs after successful CI on main branch

  • Building and publishing artifacts
  • Deploying the application to staging environment

• Release Pipeline (.github/workflows/release.yml) — runs when a version tag is created

  • Publishing a release on GitHub
  • Creating release artifacts

Detailed CI/CD documentation is available in .github/CI_CD_README.md