Help!

Live Demo:

Summary

A web based application that provides quick and easy access to Autobody and Repair Shops, Towing Companies, and Emergency resources in your area. Help! is built with love, paitience, and the MERN stack ( MongoDB, Express, React, Node.js).

Testimonials

“What can I say about Help! that hasn’t already been said about the wheel, penicillin, or the iPhone…. this is one of the greatest inventions of all time. ”
— Larry Ellison

“You know life ain't tied with a bow but it's still a gift though”
— Kodak Black

“I'm using it for a year now and many projects, it's an awesome boilerplate and the project is well maintained!”
— Kevin Granger

Prerequisites
Getting Started
Technologies
Obtaining API Keys
Project Structure
Support
Contributing
License

Prerequisites

MongoDB
Node.js 6.0+
Command Line Tools
Mac OS X: Xcode (or OS X 10.9+: xcode-select --install)
Windows: Visual Studio
Ubuntu / Linux Mint: sudo apt-get install build-essential
Fedora: sudo dnf groupinstall "Development Tools"
OpenSUSE: sudo zypper install --type pattern devel_basis

Getting Started

The easiest way to get started is to clone the repository:

# Get the latest snapshot
git clone --depth=1 https://github.com/ruthieirl/help.git myproject

# Change directory
cd myproject

# Install NPM dependencies
npm install

# Then simply start your app
node app.js

Technologies

HTML5
CSS3
- Bootstrap
- Bootswatch
- FontAwesome
Javascript
jQuery
Moment.js
AJAX
Database
- Firebase
APIs
- GoogleMaps API
- OpenWeatherMap API

Obtaining API Keys

Visit Google Cloud Console
Click on the Create Project button
Enter Project Name, then click on Create button
Then click on APIs & auth in the sidebar and select API tab
Click on Google+ API under Social APIs, then click Enable API
Next, under APIs & auth in the sidebar click on Credentials tab
Click on Create new Client ID button
Select Web Application and click on Configure Consent Screen
Fill out the required fields then click on Save
In the Create Client ID modal dialog:
Application Type: Web Application
Authorized Javascript origins: http://localhost:3000
Authorized redirect URI: http://localhost:3000/auth/google/callback
Click on Create Client ID button
Copy and paste Client ID and Client secret keys into .env

Note: When you ready to deploy to production don't forget to add your new url to Authorized Javascript origins and Authorized redirect URI, e.g. http://my-awesome-app.herokuapp.com and http://my-awesome-app.herokuapp.com/auth/google/callback respectively. The same goes for other providers.

Project Structure

|-- assets/
|  |-- css/
|     |-- digital-7.ttf                 // Imported Font 
|     |-- style.css                     // Local CSS Styles
|  |-- images/                             
|  |-- js/                             
|     |-- app.js                    // Configures the connection to the database / Methods for Adding / Removing Trains
|     |-- weather.js                // Methods for getting and setting the weather from Open Weather API
| 
| -- index.html                     // Main HTML page with structure

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

wrainaud/help