Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ankithans/help-me

When there's none to go to. In times of danger or trouble, there is nowhere to seek help from. Help-me comes with an innovative solution to the above problem. It will automatically send notifications to your nearby people and it will be the moral duty of the people to help the person in danger.
https://github.com/ankithans/help-me

danger flutter hackathon hackathon-2020 hackathon-project help-me heroku workmanager

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/ankithans/help-me
Owner: ankithans
License: mit
Created: 2020-11-04T09:42:07.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2022-12-22T19:02:10.000Z (about 2 years ago)
Last Synced: 2024-04-14T10:12:03.558Z (10 months ago)
Topics: danger, flutter, hackathon, hackathon-2020, hackathon-project, help-me, heroku, workmanager
Language: Dart
Homepage: https://help-mee.herokuapp.com/
Size: 1.09 MB
Stars: 27
Watchers: 1
Forks: 3
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: License.md

Awesome Lists containing this project

README

# Help-me

## 🔗 Links
- [Help-me apk](https://github.com/ankithans/help-me/releases/download/v1.0/app-armeabi-v7a-release.apk)
- [Backend API](https://help-mee.herokuapp.com/)
- [API documentation](https://documenter.getpostman.com/view/11391372/TVYQ2EBd#136607c4-b3cb-4e7f-9c96-82f7950aeee7)
- [Video Explanation](https://vimeo.com/476800666)

## ❓ Problem Statement
> Security is a major concern today. As sad this might sound, India or any part of the world for that matter cannot be called completely safe. And as such any cry for help should always get the proper response that the person needs. Thus, we bring forward helpMe. helpMe is our contribution towards a safer world where no one is alone and a step towards a much safer world.
Whenever in distress, press a button and this will automatically notify people nearby of your location and others can respond to your distress call. This creates a social responsibility among users and eliminates any central body ensuring quicker response to any distress calls.

## 🤔 Challenges we faced
- Handling location changes in the background
- Finding nearby users (queries in mongodb using geolocation object)
- Configuring Hardware buttons (comming soon)

## 💡 features
- send distress messages automatically when you are in trouble
- receive notifications from others when they are in trouble and access their location using google maps
- add close contacts (automatically send them messages when you are in trouble)
- configure hardware buttons (comming soon)

## 💻 samples:

## 👣 steps to run the project
- clone the repo in your local machine
- do ```yarn``` in root directory
- do ```flutter pub get``` in ```client/helpMe```
- add firebase to your flutter project and firebaseadminsdk.json in your root directory
- add MONGO_URI, JWT_SECRET, TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN in your .env
- do ```yarn dev``` in the root directory and your backend is up and running
- do ```flutter run``` in ```client/helpMe``` and your app will start with no issues

## Tech Stacks & dependencies
##### 🤖 Backend
- nodejs
- mongodb
- Heroku
- Firebase FCM
- twilio

##### 🌟 Frontend
- Flutter for cross-platform application
- [location](https://pub.dev/packages/location)
- [http](https://pub.dev/packages/http)
- [firebase_messaging](https://pub.dev/packages/firebase_messaging)
- [flutter_secure_storage](https://pub.dev/packages/flutter_secure_storage)
- [flutter_local_notifications](https://pub.dev/packages/flutter_local_notifications)
- [workmanager](https://pub.dev/packages/workmanager)
- [maps_launcher](https://pub.dev/packages/maps_launcher)

## made with 💕 by:
- [Ankit Hans](https://github.com/ankithans)
- [Sagnik Biswas](https://github.com/sbiswas2209)
- [Harshit Singh](https://github.com/HarshitSingh27)