Skip to content

Client application for an emergency response system (ERS), CSC 211 (Software Workshop II) project.

License

Notifications You must be signed in to change notification settings

dev-xero/sos-client

Repository files navigation

SOS

Kotlin Compose License

The SOS client is a Kotlin-based Android app for an Emergency Response System (ERS) that can quickly alert emergency services with a single tap. It shares the user’s real-time location and notifies configured contacts instantly.

Written with Jetpack Compose and integrates with our Spring Boot backend. This source code is part of the CSC 211 (Software Workshop II) course project for group 1.

Features

1. SOS Button

  • Single-tap button that notifies pre-configured emergency responders
  • Shares real-time GPS coordinates
  • Default emergency actions include:
    • Police
    • Hospital
    • Fire Station
    • Family

2. Live Location Sharing

  • Real-time GPS sharing with the backend
  • Enables location-aware responder dispatchng

3. Emergency Contact List

  • Add trusted family/friends as emergency contacts
  • Default contact is prompted during setup

4. Incident Reporting

  • Report incidents like theft, accidents or fires
  • Include:
    • Type of Incident
    • Description
    • Optional photo/video
    • Auto-detected and editable location

5. Automated Emergency Messaging

  • Customizable emergency settings:
    • Auto-call / Auto-SMS
    • Silent mode
    • Who to notify and how

Setup Instructions

Prerequisites

  • Android Studio Giraffe or later
  • Kotlin 1.9+
  • Android SDK 33+

Clone the repository

git clone https://github.com/dev-xero/sos-client.git
cd sos-client

Run

  1. Open the project in Android Studio
  2. Connect your Android device or emulator
  3. Click Run or F10

Libraries

  • Kotlin & Jetpack Compose
  • Core androidx libraries
  • Splash API
  • Dagger Hilt for dependency injection
  • Compose Navigation
  • Datastore preferences for app preferences
  • Google Play Location API services
  • Google Accompanist for api compatibility

Technical Stack

Layer Technology
Mobile Kotlin, Jetpack Compose, AndroidX
Backend Spring Boot, PostgreSQL
CI/CD GitHub Actions
Infra Docker, AWS

Contributing

Before contributing, read the contents of the docs/ folder and familarize yourself with the project structure.

Contributors

About

Client application for an emergency response system (ERS), CSC 211 (Software Workshop II) project.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages