Skip to content

A personal safety app with a panic button, geo-location, and Twilio integration. Built with React.

License

Notifications You must be signed in to change notification settings

ShreyRavi/walk-safe-home

Repository files navigation

WalkSafe Home is a React-powered personal safety app in development that provides easy access to emergency contact with the click of just one button. Inspired by friends who needed a lightweight panic button application that did not require an app download and would work on any device.


Screenshots of the WalkSafe Personal Safety App's homepage.

Live React web-app deployed to a Github Pages environment, accessible at www.walksafe.co.

React Native versions will be pushed on a seperate branch on this repository named walksafe-react-native when completed and published.

Usage

WalkSafe Home is a personal safety app that calls and texts a user's emergency contacts with the click of just one button. When the panic button is clicked, one contact of the user's choice will be called from their phone. In addition, up to 5 other number(s) will be texted an SOS message automatically from our service.

Local Setup

  1. Clone Repository
git clone https://github.com/ShreyRavi/walk-safe-home.git
  1. Use npm to install required modules
npm install
  1. Run the React project using npm
npm start
  1. Navigate to https://localhost:3000/ (if not automatically opened) to see React app locally

React Components

  • SettingsDrawer - a React component that holds the logic and UI for editing the number(s) to be called or texted
    • CallInput - a React component that holds the logic and UI for editing the number to be called
    • TextInput - a React component that holds the logic and UI for editing the number(s) to be texted
  • PanicButton - a React component that holds Geolocation component and main logic for showing and activating the panic button
    • Alert - a React component that holds the code to show a MuiAlert from Material-UI
  • Header - a React component that showcases a Material-UI top AppBar and serves as the header of the app
  • HelpDrawer - a React component that holds the logic the informational left drawer activated by clicking on the top-left button
    • Footer - a React component that displays typical footer information

Built With

Future Plans

  • Add Twilio integration
  • Add user accounts and back-end database
  • Release React Native app for iOS & Android
  • Improve UI to better serve users

License

The MIT License (MIT)

Disclaimer

WalkSafe Home is not a replacement for law enforcement or safety practices. Use at your own risk.

About

A personal safety app with a panic button, geo-location, and Twilio integration. Built with React.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published