https://github.com/mahmud0808/sheguard

Introducing your ultimate safety companion. This app keeps you confident and secure with real-time location tracking and emergency alerts.
https://github.com/mahmud0808/sheguard

android android-app android-application firebase safety safety-application women-safety

Last synced: about 13 hours ago
JSON representation

Introducing your ultimate safety companion. This app keeps you confident and secure with real-time location tracking and emergency alerts.

• Host: GitHub
• URL: https://github.com/mahmud0808/sheguard
• Owner: Mahmud0808
• License: mit
• Created: 2023-09-28T08:09:25.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-25T15:47:21.000Z (4 months ago)
• Last Synced: 2024-07-25T18:14:36.251Z (4 months ago)
• Topics: android, android-app, android-application, firebase, safety, safety-application, women-safety
• Language: Java
• Homepage:
• Size: 5.7 MB
• Stars: 14
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# ✨ SheGuard

SheGuard stands as the quintessential companion for women, ensuring their safety in every circumstance. Through its user-friendly features, it empowers you to swiftly alert your loved ones of your whereabouts and connect with emergency services effortlessly.

## Screenshots 📱



   

   

  



## Features 🔥

- **User Management:**

  - **Login and Registration:** Easy access for users.

- **Safety Measures:**

  - **Live Location Sharing:** Instantly share your location with trusted contacts.

  - **Trusted Contacts:** Add up to 10 trusted contacts for quick access.

  - **User Notifications:** Alert contacts who are also SheGuard users via notifications.

  - **SMS Notifications:** Reach out to non-users via SMS notifications.

- **Emergency Assistance:**

  - **Emergency Helplines:** Access important emergency contact numbers.

  - **Safety Tips:** Learn from a list of safety tips to stay secure.

- **SOS Mode:**

  - **Shake Detection:** Trigger SOS mode with a simple shake gesture.

  - **Audible Alert:** Activate a loud siren to attract attention.

  - **Automatic Emergency Call:** Connect with emergency services instantly in SOS mode.

## Architecture 🗼

This app uses [***Firebase***](https://firebase.google.com/) services.

## Build-Tool 🧰

You need to have [Android Studio Giraffe or above](https://developer.android.com/studio) to build this project.

## Getting Started 🚀

- In Android Studio project, go to `Tools` > `Firebase` > `Authentication` > `Authenticate using a custom authentication system`:

  - First, `Connect to Firebase`

  - After that, `Add the Firebase Authentication SDK to your app`

- Now open your project's [Firebase Console](https://console.firebase.google.com/) > `Authentication` > `Sign-in method`:

  - Enable `Email/Password`

  - Do not enable `Email link (passwordless sign-in)`

- Enable [Token Service API](https://console.cloud.google.com/apis/library/securetoken.googleapis.com)

- After that, go to your project's [Firebase Console](https://console.firebase.google.com/) > `Settings icon` (beside Project Overview) > `Project Settings` > `Service accounts`:

  - Generate new private key, rename the key to `service_account.json` and paste the file in [/res/raw](https://github.com/Mahmud0808/SheGuard/tree/master/app/src/main/res/raw)

- Open the `service_account.json` file:

  - Copy the `project_id` of your private key and paste it in [NotificationAPI.java](https://github.com/Mahmud0808/SheGuard/blob/master/app/src/main/java/com/android/sheguard/api/NotificationAPI.java)

- That's it. Now you are good to go!

## Contact 📩

Wanna reach out to me? DM me at 👇

Email: [email protected]

## Donation 💰

If this project help you reduce time to develop, you can give me a cup of coffee :)



## Credits 🤝

- [icons8.com](https://icons8.com) for the in-app icons.