README.md

✨ 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 services.

Build-Tool 🧰

You need to have Android Studio Giraffe or above 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 > Authentication > Sign-in method:

  • Enable Email/Password
  • Do not enable Email link (passwordless sign-in)

• Enable Token Service API

• After that, go to your project's Firebase Console > 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

• Open the service_account.json file:

  • Copy the project_id of your private key and paste it in 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 for the in-app icons.