add readme contrib to docs

docs/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributions Welcome
+
+Thanks for your interest in contributing to **Offline Google Maps Navigator**! Contributing to open source projects like this one can be a rewarding way to learn, teach, and build experience. Not only that, contributing is a great way to get involved with _social coding_. We are excited to see what amazing contributions you will make, as well as how your contributions will benefit others.
+
+If you are new to contributing to open source projects, the process can be intimidating. Not to worry! To help ensure both you and the community get the most out of your contributions, we've put together the following guidelines.
+
+## Table of Contents
+
+1. [Types of Contributions](#types-of-contributions)
+1. [Ground Rules & Expectations](#ground-rules--expectations)
+1. [How to Contribute](#how-to-contribute)
+
+---
+
+## Types of Contributions
+
+The common misconception about contributing to an open source project is that you need to contribute code. In fact, there are numerous ways you can directly contribute. To give you some ideas of how you can contribute, here are some examples of the types of contributions we are looking for:
+
+### Developers can:
+
+* Take a look at the [open issues][issues] and find one you can tackle.
+
+* Locate and fix bugs.
+
+* Implement innovative and awesome new features.
+
+* Help to improve tooling and testing.
+
+### Organizers and Planners can:
+
+* Link to duplicate issues, and suggest new issue labels, to help keep things organized.
+
+* Go through the [open issues][issues] and suggest closing old ones.
+
+* Ask clarifying questions on recently opened issues to move the discussion forward.
+
+* Help to organize meetups about the project.
+
+### Writers can:
+
+* Help to fix or improve the project's documentation.
+
+* Contribute to the project's [Wiki][wiki].
+
+### Designers can:
+
+* Design wire frames, mock-ups, graphical assets, and logos.
+
+* Put together a style guide to help the project have a consistent visual design.
+
+### Supporters can:
+
+* Answer questions for people on open issues, or about the project in general.
+
+* Help to moderate discussion boards or conversation channels.
+
+## Ground Rules & Expectations
+
+Since the project is constantly being updated with contributions of all sorts, it is important to establish ground rules and as well as expectations. This helps to ensure the best possible experience for users of the Offline Google Maps Navigator application, as well as encourage a positive, helpful, and lively community of active contributors just like you!
+
+Please make sure you read our [code of conduct][code-of-conduct] prior to contributing.
+
+## How to Contribute
+
+If you'd like to contribute, a good place to start is by searching through the [issues][issues] and [pull requests][pull-requests] to see if someone else had a similar idea or question.
+
+If you don't see your idea listed, and you think it fits into the goals of the project, you should:
+
+* **Minor Contribution _(e.g., typo fix)_:** Open a pull request
+* **Major Contribution _(e.g., new feature)_:** Start by opening an issue first. That way, other people can weigh in on the discussion and planning before you do any work.
+
+To start making a contribution:
+
+1. `fork` the project repository by clicking the **fork** button on GitHub.![fork](https://help.github.com/assets/images/help/repository/fork_button.jpg) 
+
+1. `clone` your forked repository (_noob tip: the actual command you type in is everything after the $_):
+
+   ```shell
+   $ git clone https://github.com/<YOUR-USERNAME>/googleMaps-offline-navigator
+   ```
+
+1. Add a new remote that points to the original project so you can sync project changes with your local copy:
+
+   ```shell
+   $ git remote add upstream https://github.com/TheDevPath/googleMaps-offline-navigator
+   ```
+
+1. Pull upstream changes into your local repositories `development` branch:
+
+   ```shell
+   $ git checkout development
+   $ git pull upstream development && git push origin development
+   ```
+
+1. Create a new branch from the `development` branch:
+![branch](https://help.github.com/assets/images/help/branch/branch-selection-dropdown.png)
+
+   **IMPORTANT:** Make sure you are on the `development` branch first.
+
+   ```shell
+   $ git checkout -b <YOUR-NEW-BRANCH>
+   ```
+
+1. Make your contribution to the project code.
+
+1. Write or adapt tests as needed.
+
+1. Add or change documentation as needed.
+
+1. After commiting changes, push your branch to your fork on Github, the remote `origin`:
+
+   **IMPORTANT:** Your commit message should be in present tense and should describe what the commit, when applied, does to the code - not what you did to the code.
+
+   ```shell
+   $ git push -u origin <YOUR-NEW-BRANCH>
+   ```
+
+1. From your forked GitHub repository, open a pull request in the branch containing your contributions. Target the project's `development` branch for the pull request.
+
+1. At this point, your contribution has been submitted for review. Please be patient while your contribution is being reviewed as this can take some time. Meanwhile, if there are questions or comments on your contribution, please respond and/or update with future commits.
+
+1. Once the pull request is approved and merged, you can pull the changes from `upstream` to your local repository and delete your extra branch(es).
+
+1. Don't forget to check out more [about] this project  
+
+Happy contributing!
+
+[issues]: https://github.com/TheDevPath/googleMaps-offline-navigator/issues
+[pull-requests]: https://github.com/TheDevPath/googleMaps-offline-navigator/pulls
+[wiki]: https://github.com/TheDevPath/googleMaps-offline-navigator/wiki
+[code-of-conduct]: ./CODE_OF_CONDUCT.md
+[about]: https://github.com/TheDevPath/googleMaps-offline-navigator/blob/static-docs/README.md

docs/README.md

@@ -0,0 +1,125 @@
+# Getting Started
+See the Guide on how to contribute [here](https://github.com/TheDevPath/googleMaps-offline-navigator/blob/development/CONTRIBUTING.md#how-to-contribute) for instructions on how to fork and set up your repository.
+
+# Installing Dependencies
+In the root directory of your newly cloned project `npm install`
+
+In the client directory of your project `npm install`
+
+Skip this next part if you know what you are doing
+
+---
+
+Noob tip 
+
+*If you can, "clone with `SSH` instead of clone with `HTTPS`. This means that, when you type in git remote add origin, you should use a link that looks like this: `[email protected]:*YOUR_USER_NAME/YOUR_REPO_NAME.git.*` Observe how that differs from* `https://github.com/YOUR_USER_NAME/YOUR_REPO_NAME.git`* 
+While the first creates a remote that uses `ssh` authentication, the latter uses `https`, so it'll always prompt you to enter your username and password to authenticate the connection. For more see this [link](https://gist.github.com/juemura/899241d73cf719de7f540fc68071bd7d)*
+
+---
+
+# Get Google Maps API key
+
+- In the config subdirectory you will find secrets-*example.json. *Copy it's contents to a new file called secrets.json in the same directory*.
+
+- Next get a [Google Maps API key](https://developers.google.com/maps/documentation/javascript/get-api-key)
+
+    - Click on the button
+
+    - This will take you through the process
+
+    - Note: If you have an existing API key, you may use that key.
+[Detailed instructions](https://developers.google.com/maps/documentation/javascript/get-api-key)
+
+- Open `secrets.json` and under googlemaps, paste your API key and save
+
+# Install mongodb
+
+You also need to install and have running mongoDB - Directions can be found [here](https://docs.mongodb.com/manual/installation/)
+
+# Update and run
+
+When installation has completed go to where you installed the project and run `npm install` again to install the root and client dependencies. This will update the file package.json in the root of your project. 
+
+When finished, in the project's root directory type `npm run dev`. This will start the dev servers on `localhost:8080` & `localhost:8081` respectively
+
+
+# About googleMaps-offline-navigator
+
+This is an open source project for Grow with Google Udacity Scholarship Challenge - Navigation app using offline first strategy and google maps api
+
+The idea for this project is to build a progressive web app utilizing the technologies learned in the Grow with Google Udacity Scholarship challenge.
+
+The project idea - build a navigation app that will store a local copy of pre selected directions and maps so that navigation continues to work properly in poor to no signal scenarios.
+
+The stack - this will be a node app utilizing Preact for the front end.
+
+Pull requests are welcome!
+
+## Table of Contents
+
+- [Main Goal](#main-goal)
+- [Features](#features)
+- [About the application](#about-the-application)
+- [Where to get the files](#where-to-get-the-files)
+- [Key files included](#key-files-included)
+- [Requirements](#requirements)
+- [ToDo](#todo)
+
+
+## Main Goal
+
+The main goal of the app is to provide the user with a map interface that they can use on their mobile device and that will continue to be useful in poor to no signal environments.
+
+## Features
+
+* The interface will **display a map** of a designated area
+
+
+* **Users** will be able to:  
+    * Search for a location
+        * By typing into a search field
+    * Drop a pin at a location
+        * By placing a pin on the map
+        * By clicking 'drop pin' next to search results
+    * Get directions to a selected location from:
+        * Their current location
+        * Another dropped pin
+    * Save a dropped pin
+    * Save a set of directions
+    * View list of dropped pins ('saved places')
+    * View list of directions ('saved directions')
+
+
+* **The app** will:
+    * Use the Google Maps API to:
+        * Display the map
+        * Provide a search interface
+        * Provide a current location
+        * Provide directions
+    * Interface with a database to save a users:
+        * Saved places
+        * Saved directions
+    * Maintain last state on loss of signal including:
+        * Current map View
+        * Saved places
+        * Saved directions
+
+
+### *About the application*
+* Node backend
+* React Frontend
+* Google Maps api
+* Service Workers
+* [MIT License](../blob/master/LICENSE)
+
+### *Where to get the files*
+* [This repository](https://github.com/TheDevPath/googleMaps-offline-navigator)
+
+### *Key files included*
+* Files
+
+## *Requirements*
+* Requirements
+
+## *ToDo*
+* Improvements

docs/color-scheme.md

@@ -0,0 +1,35 @@
+# Color Palettes
+
+Here's a couple color palettes we could potentially use for the app. Let me know what you all think. I'll add the Adobe Color CC links as well so you have easier access to the values.
+
+I placed the primary colors in the center. With neutrals on the right and a contrasting color on the left.
+
+I wanted to use a green or blue since there are connections to adventure and nature with using a map. 
+
+Green Theme Values: 
+
+|              |RGB               |HEX    |
+|--------------|------------------|-------|
+|Primary       |rgb(59, 138, 59)  |#3B8A3B|
+|Primary Light |rgb(112, 156, 96) |#709C60|
+|Primary Accent|rgb(255, 250, 204)|#FFFACC|
+|Light         |rgb(240, 235, 240)|#F0EBF0|
+|Dark          |rgb(41, 36, 41)   |#292429|
+
+Blue Theme Values:
+
+|              |RGB               |HEX    |
+|--------------|------------------|-------|
+|Primary       |rgb(44, 91, 97)   |#2C5B61|
+|Primary Light |rgb(90, 152, 161) |#5A98A1|
+|Primary Accent|rgb(255, 252, 222)|#FFFCDE|
+|Light         |rgb(240, 235, 240)|#F0EBF0|
+|Dark          |rgb(41, 36, 41)   |#292429|
+
+<div align="center">
+    <img width="80%" src="images/green-theme.png"/>
+</div>
+
+<div align="center">
+    <img width="80%" src="images/blue-theme.png"/>
+</div>