How younisyousaf/final-year-project works
Project Overview and Purpose
• The project is a final year system that integrates several technologies to build a real-time vehicle tracking solution.
• It comprises a web-based user interface (built with React JS), a back-end REST API / business layer (using C#.Net), and a mobile application component (developed in Flutter).
• The system delivers live traffic updates, speed monitoring, and route optimization in real-time. It is intended as a robust, research-driven and innovative platform with high extensibility.
Identifying the Main Components
• Frontend (Web):
• Located under the “vTrack/frontend” folder, it includes two main sub-projects: a shared module (API integration, state management, common UI components) and a web application (React-based).
• It handles user authentication, asset management, live tracking views, reports, and configuration screens.
• Backend (API and Services):
• Found in “vTrack/backend”, it is subdivided into multiple layers:
• API Layer – “VTrack.Api”: contains controllers (AssetsController, DevicesController, HealthController, etc.) and even SignalR hubs (for real-time notifications).
• Business/Service Layer – “VTrack.Api.Services” and “VTrack.Core.Services”: responsible for application logic (asset management, device operations, location filtering, identity server integration for authentication, etc.).
• Data Access – “VTrack.DataAccess” and its “Mongo” subdirectory: provides repository patterns, data models, and abstraction over the database (likely a MongoDB instance or possibly SQL, with the possibility of a SQL backend as mentioned in the README).
• Testing and Auxiliary Projects – including device simulation “VTrack.Listener.DeviceSimulator” (for generating live tracking data) and various tests.
• Mobile App:
• Under “vehicle_tracking_mobile_app”, implemented in Flutter, with separate directories for Android, iOS, and other platform-specific configurations.
• This component interacts with the back-end to send real-time data from smartphones and display tracking info.
Architectural Patterns and Interactions
• Layered Architecture / Separation of Concerns:
• The back-end is clearly divided into API controllers, service logic, and data access layers. This enforces separation of concerns and easier testability.
• Real-time communication:
• The API layer includes a SignalR hub and a Listener which likely supports device simulation and real-time data push to the frontend.
• Microservices/Modular Services:
• Although packaged in a single repository, different modules like identity services, asset management, device management, and reporting are separated into distinct projects.
• Containerization and CI/CD:
• Presence of Dockerfiles, docker-compose files, and GitHub workflows indicates that containerization is used for deployment and there is an automated CI/CD pipeline.
Relevant Technologies and Tools
• Frontend:
• React JS, state management (custom hooks and possibly context APIs), Orval (for API code generation), and Tailwind CSS for styling.
• Backend:
• C#.Net, ASP.NET Core Web API, SignalR for real-time data, Identity Server for authentication, and a repository/data access pattern likely abstracting a Mongo or SQL database.
• Mobile:
• Flutter for building Android, iOS, and other cross-platform mobile apps.
• Additional DevOps:
• Docker for containerization, GitHub actions for continuous integration, and build scripts for managing container images.