Skip to content

Latest commit

Β 

History

History
57 lines (43 loc) Β· 2.52 KB

README.md

File metadata and controls

57 lines (43 loc) Β· 2.52 KB

CrimeCraft

CrimeCraft is an intuitive application designed to facilitate crime reporting and management. With its feature-rich design and user-friendly interface, CrimeCraft allows users to document, track, and manage crime-related data efficiently, enhancing community safety.

πŸš€ Features

  • Crime Registration: Record detailed information about crimes, including descriptions and timestamps.
  • Photo Integration: Attach images of crime scenes for better documentation.
  • Priority-Based Display: View crime reports sorted by priority levels.
  • Data Persistence: Store crime reports locally until resolved by the relevant authority.
  • Material Design: Modern UI components for an optimized user experience.

πŸ› οΈ Technologies & Methodologies

CrimeCraft is built using modern Android development best practices, incorporating:

  • Kotlin: Primary programming language.
  • MVVM Architecture: Ensuring maintainability and scalability.
  • Room Database: Local data storage for crime reports.
  • Retrofit: API communication (future implementation).
  • View Binding: For efficient UI handling.
  • Glide: Image loading and caching.

🎬 Screenshots

CrimeCraft Screenshot 1

CrimeCraft Screenshot 2

πŸ“Œ Getting Started

Prerequisites

  • Android Studio (latest version recommended)
  • Minimum SDK: 21 (Android 5.0 Lollipop)
  • Gradle (ensure compatibility with project configuration)

Installation

  1. Clone the repository:
    git clone https://github.com/mshajkarami/CrimeCraft.git
  2. Open the project in Android Studio.
  3. Sync the project with Gradle files.
  4. Build and run the app on an emulator or physical device.

🀝 Contribution Guidelines

We welcome contributions to improve CrimeCraft! Follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit changes with clear and concise messages.
  4. Follow the coding standards (e.g., Kotlin style guide, MVVM structure).
  5. Submit a pull request with a detailed description of changes.

πŸ“œ License

This project is licensed under the MIT License. See the LICENSE file for details.


Feel free to reach out if you have any questions or feedback about CrimeCraft. We hope this application contributes to a safer and more connected community! πŸš”βœ¨