Git Product home page Git Product logo

herohelp's Introduction

HeroHelp

HeroHelp Logo

HeroHelp is the modern-day Bat Signal. More specifically, it's a two-sided real-time coordinated mobile app system for incident management. Citizens can call for help and Heroes can respond to dispatches and resolve incidents.

This project was created by four students at Fullstack Academy in Chicago. We had two weeks to put together a Capstone project -- a prototype application incorporating web technologies learned during the prior 10 weeks of the program as well as new technologies we were interested in exploring. We chose to explore integrating websockets with Google Maps and React Native to create a real-time incident management system.

HeroHelp Demo

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

HeroHelp was primarily developed for the Apple IPhone 7S. Although react-native works across mobile platforms, it hasn't been tested on other platforms so there may be incompatibilities.

To run the react-native apps, you have a few options:

  1. If you have a Mac, you can run the iPhone simulator
  2. If you have an iPhone, you can run HeroHelp on your phone via Expo

Installing

This repo contains multiple projects (i.e. admin, client, server, simulator, etc) that have their own package dependencies. To install, you must navigate into each of these top-level directories and run

npm install

An explanation of the top-level projects:

  • admin : contains the admin interface
  • client : contains the Citizen & Hero React Native apps
  • server : contains the backend-server
  • simulator : contains the simulator. Essentially a node client that simulates the Citizen and Hero clients for helping to test the React Native apps independently

You can find more specific information on each of the projects in the READMEs for each of the projects.

admin This project is a web app that displays information about the running system that would be useful to an operator (Ex: incidents in progress, heatmap of incidents, which hero is assigned to what incident, etc). It's dependent on the server project b/c it uses the server's database code to access the same database.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

Link to Demo Video

https://www.youtube.com/watch?v=N5SJ75VoWKA&amp=&t=0s&amp=&index=13

herohelp's People

Contributors

tmkelly28 avatar brandonjyee avatar jeffhauserchi avatar glebec avatar jsmith2890 avatar bradsmith712 avatar geoffbass avatar collin avatar fterdal avatar avillr avatar sethfork avatar khumphrey avatar queerviolet avatar omriackley avatar connieelee avatar knxyzkn avatar rinaldo 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.