Skip to content

Eshaan-byte/HISTORY-APP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ›οΈ Historical App An Android application that demonstrates best practices in modern Android development including API integration, clean architecture, and lifecycle-aware UI design.

πŸ“± Features πŸ” Login Screen – Authenticates users using a username and password.

πŸ—“οΈ Dashboard Screen – Displays a list of historical events fetched from a remote API.

πŸ“œ Details Screen – Shows in-depth information about selected historical events.

πŸ—οΈ Architecture & Technologies This project is built using modern Android architecture components and tools:

Clean Architecture – Structured with a clear separation of concerns across data, domain, and presentation layers. MVVM (Model-View-ViewModel) – Ensures a clean and testable codebase. Hilt – Simplifies dependency injection and lifecycle management. Retrofit – For efficient and type-safe HTTP communication. Kotlin Coroutines – Handles asynchronous operations smoothly. LiveData & ViewModel – Ensures UI components reactively respond to data changes. ViewBinding – Enables type-safe interaction with layout views.

🌐 API Integration πŸ”‘ Login Endpoint Base URL: https://nit3213api.onrender.com Endpoint: /sydney/auth Method: POST Request Body (JSON):

json { "username": "Eshaan", "password": "s8093457" } πŸ“‹ Dashboard Endpoint Endpoint: /dashboard/{keypass}

Method: GET

Replace {keypass} with the token received from the login response.

βœ… Testing Unit tests are provided for key components like ViewModel logic.

Run Tests in Android Studio: Open the project in Android Studio.

Navigate to the test directory.

Right-click on the folder and select Run Tests.

πŸ“‚ Project Structure Highlights

Screenshot 2025-05-21 at 2 14 55 pm

πŸ› οΈ Requirements Android Studio Hedgehog or later Kotlin 1.8+ Gradle 8+ Minimum SDK: 24

🀝 Contributions Feel free to open issues or submit pull requests if you'd like to improve or extend the functionality!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages