Git Product home page Git Product logo

shagun25 / sheheroes Goto Github PK

View Code? Open in Web Editor NEW
76.0 2.0 92.0 194.95 MB

SheHeroes- A Women And Child Safety App

Home Page: https://discord.com/channels/811724426965811210/815018090991321099

License: Creative Commons Zero v1.0 Universal

Java 0.13% Swift 0.11% Objective-C 0.01% Dart 86.43% Ruby 0.38% Kotlin 0.04% HTML 4.09% CSS 4.53% JavaScript 4.28%
gssoc21 women police-siren sos police-stations opensource flutter-app dart crosswoc

sheheroes's Introduction

SheHeroes

Issues Pull Requests Forks Stars  

🅂🄷🄴🄷🄴🅁🄾🄴🅂 - 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 recent times, We wanted to give it 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 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 a local machine using

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

This makes a local copy of the repository in your machine.

Once you have cloned the SheHeroes repository in Github, move to that folder first using the 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, let’s 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 the 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 a contribution. Please create a separate branch using command and keep your master branch clean (i.e. synced with remote branch).

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

Create a separate branch for contribution and try to use the same name of the branch as in the folder.

To switch to the 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 reviewer 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 the 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 us to set the more cautious timings).
🔘 Consider the situation as emergency as if the shake and vibrations around the device exceed the fixed limit.
🔘 SOS without opening app in an 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 the situation gets safe afterward 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 wonderful people: ✨

SheHeroes 🅂🄷🄴🄷🄴🅁🄾🄴🅂

Issues Pull Requests Forks Stars  

sheheroes's People

Contributors

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

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

sheheroes's Issues

Adding viewport meta tag.

I would like to add viewport meta tag to /Sheheroes_WatchOS/web/index.html.

I would be adding some important values to it like viewport and content as it is an important tag to mitigate the virtual viewport on narrow screen devices.
It also controls layout on mobile browsers. It will be good to add this tag to "SheHeros"

Thus, I request @hiashutoshsingh to please /assign me this issue.
POINTS-25

Record audio in background

Feature: - Record audio in background

Expected Behaviour: - Record audio when the user clicks the in the background state, then save it to the local store in the app.
POINTS-25

Capture image in foreground

Feature: Capture image in the foreground

Expected Behaviour: In case of emergency capture image in the foreground and save in local storage of app.

POINTS-25

Add github action to auto label issues

Add GitHub action to auto label issues with gssoc21 label when contributor asks to work under gssoc21. Kindly assign me this issue as a part of Girl Script Summer of Code.

Uploading video/image/audio files between using firebase

Feature: - Uploading video/image/audio files using firebase.

Expected Behaviour: -Upload video/image/audio files on cloud storage of firebase.
STEP 1: Initialize user with firebase
STEP 2: Upload the file on cloud storage and get the documentId after uploading it.
STEP 3: Store that documentId in userDetails map and send it back to in cloud firestore.

POINTS-25

REF:
https://firebase.flutter.dev/docs/firestore/usage/#!
https://firebase.flutter.dev/docs/storage/usage

Improve the message feature

provide new ideas except following:
1.location
2. video and image capture(both back and front)
after every 5 sec.

Fake Call

Call yourself using a fake name to get out of unpleasant situations .
Inside this :

  1. Enter a fake name
  2. Timer
    You Can take help from UI provided

Fake Call

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

Timer

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

Onboarding/Walkthrough screens

Feature: Onboarding/Walkthrough of all features.
Expected Behaviour: Screens need to be added so that before using the app for the first time user can know about all the features of the app.
POINTS-25

Create Code of Conduct

I would like to add code of conduct file as code of conduct is a necessary file which the contributors need to follow so that everyone follows a decorum.

Record audio in foreground

Feature: - Record audio in foreground

Expected Behaviour: - Record audio when the user clicks the in a foreground state, then save it to the local store in the app.
POINTS-25

Clean architecture(Provider/BLOC)

Feature: Clean architecture

Expected Behaviour: App should have business logic on UI front, functions or widgets that are used frequently should be a move to common. Documenting/adding comments to the current code should adhere.
I would highly recommend the usage of Provider or Bloc Pattern.

Ref:
https://pub.dev/packages/provider
https://pub.dev/packages/bloc
https://codeburst.io/using-clean-architecture-in-flutter-d0437d0c7f87
https://ayusch.com/understanding-bloc-architecture-in-flutter/
https://www.youtube.com/watch?v=KjE2IDphA_U&list=RDCMUCSIvrn68cUk8CS8MbtBmBkA&index=5
POINTS-25

Store data of family contacts in firebase for emergency use case

Feature: - Storing phone contacts in firebase for a user.

Expected Behaviour: - User would grant permission for accessing contact list from the phone. On selecting some of the contacts from that list it would save those to the firebase. This would happen just after signup.

Take help from UI Provided.

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

Deep learning automatic model

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.

Share your ideas if you can work on this core functionalities.

Capture image in background

Feature: Capture image in the background

Expected Behaviour: In case of emergency capture image in the background and save it in the local storage of the app.
POINTS-25

Back button not working on all places

Feature: Add back button for screens and dialogue boxes

Expected Behaviour: Adding back button so that screens can be navigated back and dialogue boxes can be dismissed.

Add Issue And PR Tempaltes

Would like to add issue and pr templates to these project that will basically explain the type of issue and its description and also the type of pr the set of checklist that it obeys and its description

Kindly assign this to me as a part of Cross-Woc. I would love to do it

Record video in background

Feature: - Record video in background

Expected Behaviour: - Record video when the user clicks any button in the background, then save it to the local store in the app.
POINTS-25

notification service using firebase

Feature: Notification Service

Expected Behaviour: Core Notification service should be set up using firebase. Notification service required for activation of app, any sort of alarm if we are able to implement then we need this to work upon.
And many other features will add upon in future accordingly require this service.

Requesting permissions by user

Feature: - Permissions Handler

Expected Behaviour: - On click of button app should request permissions for below ones:
Location
Contact list
Media Access
Phone Calls
Battery Usage

Take help from UI provided.

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

Facebook Authentication Through Firebase

Describe the feature you'd like to add
I would like to add Facebook Authentication Through Firebase......

Describe how you will do it
I will use firebase to authenticate with Facebook... I already worked on that in other projects..... So, I think I can do it

Additional context
If I can forward With that,

  1. Please assign me to here
  2. Please add the labels like gssoc'21 label and other label of levels like level 1 or level 2 or level 3(Related to the issue) to here..... I am gssoc'21 participant......

Waiting for your response..... Thank you @shagun25

Migrating to flutter 2.0

Feature: Project migration to flutter 2.0

Expected Behaviour: All packages should be compatible with flutter 2.0, deprecated field should be replaced with a new one.
POINTS-25

Safety Timer

This feature will help in sending the alert messages to our emergency numbers for the timer we set.
You can take help from Ui provided.

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

Add Dialog box

Feature: Add Dialog box

Expected Behaviour: Proper dialogue box when user creds don't match while login. This should be auto-dismissible after 3 seconds.

Refactor homescreen.dart file

  • Currently the homescreen.dart file consists of around 3700+ lines of code.

  • there are several widgets like Avatar glow that can be refactored to make the code structure short, clean and maintainable.

  • it's not a easy task to review any kind of changes in such kind of large file so let me refactor that file to make it more maintainable.

  • I saw at the bottom half of the code with a Map data
    Similar as below code :-


Map data = {
    "incidents": [
      {
        "id": "98518834",
        "type": 1,
        "severity": 2,
        "eventCode": 701,
        "lat": 39.537991,
        "lng": -105.036377,
        "startTime": "2019-06-01T08:00:00",
        "endTime": "2021-06-01T17:01:00",
        "impacting": false,
        "shortDesc":
            "US-85 Santa Fe Dr: intermittent lane closures from CO-470 to Highlands Ranch Pkwy",
        "fullDesc":
            "Intermittent lane closures due to maintenance work on US-85 Santa Fe Dr both ways from CO-470 / US-85 Santa Fe Dr / County Line Rd to Highlands Ranch Pkwy.",
        "delayFromFreeFlow": 0.0,
        "delayFromTypical": 0.0,
        "distance": 6.159999847412109,
        "iconURL": "http://content.mqcdn.com/mqtraffic/const_mod.png",
        "parameterizedDescription": {
          "crossRoad2": "US-85 Santa Fe Dr / Highlands Ranch Pkwy / Dumont Way",
          "crossRoad1": "CO-470 / US-85 Santa Fe Dr / County Line Rd",
          "position2": "to",
          "direction": "both ways",
          "position1": "from",
          "eventText": "Intermittent Lane Closures, maintenance work",
          "roadName": "US-85"
        }
      },
  • Can I make this short in any way , it's an array of json values . I think we can store this in a seperate json file but would like to know your opinion what can we do with that patch .
  • if this issue seems to be legitimate, I would like to be assigned for this issue .

Record video in foreground

Feature: - Record video in foreground

Expected Behaviour: - Record video when the user clicks the in a foreground state, then save it to the local store in the app.

Emergency Hooter

Get attention in case of emergency situations. Press the activate button to Start the emergency hooter(sound) and flashlight.

add contributing.md

Hi ! I would like to create a file named contributing.md which will
Add the following -

1.Difference between GIT and GITHUB
2.How to clone,fork repository
3.How to create a branch and then use git push to push to repo
4.Create a PR
5.Squash commits in a single issue into one
6, Updating the forked and local repo as the updations are made in the upstream
I would like to work on this as a part of GSSOC'21

Sending alert message and notification using Firebase

Feature: - Alert message

Expected Behaviour: - Notification and alert messages will be sent to her added contact members. So that their contacts can track the current location of the user at that time. This would be done by sending an event from firebase to another user, if another user receives that event the notification/alert box will show up.

You can take help from UI Provided.

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

Google Authentication Through Firebase

Hello, I want to add Google Authentication Through Firebase... I noticed that email and password authentication already added, but not google authentication...I also work on google authentication in one of my projects..... So, I think, I can do it correctly..... If I can forward with that, Please assign me to here...I am also a GSSOC'21 participant......Thanks, @shagun25 ......

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.