aparnajha17/sheheroes

SheHeroes- A Women And Child Safety App

🅂🄷🄴🄷🄴🅁🄾🄴🅂 - Women Safety App

🗂 CONTENT:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 

📌 Cross WinterOfCode 21

📌 Inspiration

📌 Tech Stack

📌 Features

📌 How to get started

📌 Steps to follow

📌 Developed By

📌 ScreenShots

📌 Features We Demand

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 

🏆 We are a part of Cross WinterOfCode 21'

🏷️ Inspiration

Considering the safety and security of women in India in the recent times, We wanted to give a try from our end to address the issue in a simpler and safer way.

Looking at the recent trends and the most powerful weapon with the humanity - technology, we planned to use the same to give access to women in serious or dangerous situations to address the issue in a fast and easier way to ensure their security.

Video Description

⬆️ BACK TO CONTENT

🏷️ Tech Stack

+ Flutter +
+ Firestore +
+ Google Map Api +
+ CrimeoMeter Api +

⬆️ BACK TO CONTENT

🏷️ Features

Main Features

👉 Map - To track the current location of the user, guiding for safe routes and crime prone areas.
👉 Voice Assistant - executes features on voice commands

Additional Features

👉 SOS - SOS call and SOS messages to user provided contacts
👉 Shake - Detects the frequency of shakes and after a certain frequency sends help message with user location to provided contacts
👉 Camera - To capture image or and record video and save it to the local storage
👉 Police stations - Locates all the nearest police stations
👉 Police siren - Rings the police siren
👉 Taxi - One touch ola cab facility to books cabs for user
👉 News - To guide the users about self defense techniques

⬆️ BACK TO CONTENT

⭐ How to get started?

You can refer to the following articles on the basics of Git and Github and also contact the Project Mentors, in case you are stuck:

• Watch this video to get started, if you have no clue about open source
• Forking a Repo
• Cloning a Repo
• How to create a Pull Request
• Getting started with Git and GitHub

⬆️ BACK TO CONTENT

⭐ Steps to follow 📜

1️⃣ Fork it 🍴

You can get your own fork/copy of SheHeroes by using the Fork button.

2️⃣ Clone it 👥

You need to clone (download) it to local machine using

$ git clone https://github.com/Your_Username/SheHeroes.git

This makes a local copy of repository in your machine.

Once you have cloned the SheHeroes repository in Github, move to that folder first using change directory command on linux and Mac.

# This will change directory to a folder SheHeroes
$ cd SheHeroes

Move to this folder for all other commands.

3️⃣ Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in Github

$ git remote -v
origin  https://github.com/Your_Username/SheHeroes.git (fetch)
origin  https://github.com/Your_Username/SheHeroes.git (push)

Now, lets add a reference to the original SheHeroes repository using

$ git remote add upstream https://github.com/shagun25/SheHeroes.git

This adds a new remote named upstream.

See the changes using

$ git remote -v
origin    https://github.com/Your_Username/SheHeroes.git (fetch)
origin    https://github.com/Your_Username/SheHeroes.git (push)
upstream  https://github.com/shagun25/SheHeroes.git (fetch)
upstream  https://github.com/shagun25/SheHeroes.git (push)

4️⃣ Sync it ♻️

Always keep your local copy of repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.

# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune

# Switch to `master` branch
$ git checkout master

# Reset local `master` branch to match `upstream` repository's `master` branch
$ git reset --hard upstream/master

# Push changes to your forked `SheHeroes` repo
$ git push origin master

5️⃣ Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing by checking our Help Wanted Issues and creating pull requests.

6️⃣ Create a new branch ‼️

Whenever you are going to make contribution. Please create seperate branch using command and keep your master branch clean (i.e. synced with remote branch).

# It will create a new branch with name Branch_Name and switch to branch Folder_Name
$ git checkout -b Folder_Name

Create a seperate branch for contibution and try to use same name of branch as of folder.

To switch to desired branch

# To switch from one folder to other
$ git checkout Folder_Name

To add the changes to the branch. Use

# To add all files to branch Folder_Name
$ git add .

Type in a message relevant for the code reveiwer using

# This message get associated with all files you have changed
$ git commit -m 'relevant message'

8️⃣ Share your work 🤩

Now, Push your awesome work to your remote repository using

# To push your work to your remote repository
$ git push -u origin Folder_Name

Then, go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your precious effort.

⬆️ BACK TO CONTENT

🏷️ Developed By

• Shagun Goyal
• Charu Sachdeva
• Arshdeep Singh
• Ayushi Sharma

Note:

Look into Contributing Guidelines for contributing to this repository.

• Don't make PR directly, make issues first, once you are assigned, start working and then create a PR -Kindly join the Project Channel for discussions related to this project from here

⬆️ BACK TO CONTENT

🏷️ ScreenShots

Authentication	Voice Assistant
Emergency Dashboard	Safe Dashboard
Switcher

⬆️ BACK TO CONTENT

⭐ Features We Demand

1️⃣ AUTOMATION : Perform Tasks In Background
To make the app robust and self alarming, make it auto reactive according to some of the factors depending on surroundings listed below:
🔘 Make it more active in a particular time range(ask usr to set the more cautious timings).
🔘 Consider the situation as emergency as if the shake and vibrations around the device exceeds the fixed limit.
🔘 SOS without opening app in emergency(provide shortcut or gesture)
🔘 Auto share sms & mails & WhatsApp messages & live location to saved contacts while in emergency
🔘 While the emergency detected record the path of the user until situation gets safe afterwards and keep sharing the location checkpoints in that timespan with the saved contacts(like within 5 mins refresh location to generate checkpoint and share automatically)
🔘 Auto image capture while in emergency and share and save too.

⬆️ BACK TO CONTENT

🅂🄷🄴🄷🄴🅁🄾🄴🅂