π π·π΄π·π΄π πΎπ΄π - Women Safety App
π CONTENT:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
π
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.
+ Flutter +
+ Firestore +
+ Google Map Api +
+ CrimeoMeter Api +
π·οΈ Tech Stack
+ Flutter +
+ Firestore +
+ Google Map Api +
+ CrimeoMeter Api +
π·οΈ 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
β 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
β 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.
π·οΈ Developed By
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
π·οΈ ScreenShots
Authentication![]() |
Voice Assistant![]() |
Emergency Dashboard![]() |
Safe Dashboard![]() |
Switcher![]() |
β 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. |