Giter Club home page Giter Club logo

sheheroes's Introduction

SheHeroes

πŸ…‚πŸ„·πŸ„΄πŸ„·πŸ„΄πŸ…πŸ„ΎπŸ„΄πŸ…‚ - Women Safety App

forthebadge forthebadge forthebadge forthebadge forthebadge forthebadge

πŸ—‚ CONTENT:

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

πŸ“Œ Cross WinterOfCode 21

πŸ“Œ Inspiration

πŸ“Œ Tech Stack

πŸ“Œ Features

πŸ“Œ How to get started

πŸ“Œ Steps to follow

πŸ“Œ Developed By

πŸ“Œ ScreenShots

πŸ“Œ Features We Demand

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









🏷️ 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?

forthebadge
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:

⬆️ BACK TO CONTENT










⭐ Steps to follow πŸ“œ


0️⃣ Code of conduct

Please read our Code of conduct which stipulates explicitly that everyone must be gracious, respectful, and professional. This also documents our conflict resolution policy.

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 :octocat:

$ 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

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

Screen Shot 2020-11-21 at 10 00 58 PM

Voice Assistant

Screen Shot 2020-11-21 at 10 00 45 PM

Emergency Dashboard

Screen Shot 2020-11-21 at 10 00 32 PM

Safe Dashboard

Screen Shot 2020-11-21 at 10 00 20 PM

Switcher

Screen Shot 2020-11-21 at 10 00 06 PM

⬆️ 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










Open Source programs that Sheheroes is a part of:

Contributors:

Credit goes to these wonderfull people: ✨

SheHeroes πŸ…‚πŸ„·πŸ„΄πŸ„·πŸ„΄πŸ…πŸ„ΎπŸ„΄πŸ…‚

sheheroes's People

Contributors

shagun25 avatar hiashutoshsingh avatar samarpancoder2002 avatar samdid avatar wseng avatar arshdeepsahni avatar charu271 avatar kartik495 avatar pawan2806 avatar kanak22 avatar hridhi avatar neha62-lit avatar anirudhsai20 avatar vrushti24 avatar nathsagar24 avatar chinmoy12c avatar abstrxtinfinity avatar diksha-11 avatar rohan-kulkarni-25 avatar saransh-cpp avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.