diff --git a/README.md b/README.md index efad61e..ba86d00 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # phpGPS -A php based webservice for GPS tracking with Google Maps integration +A PHP based web service for GPS tracking with Google Maps integration ======== www.mikelduke.com ******************************************************************************* -A php based webservice for GPS tracking with Google Maps integration +A PHP based web service for GPS tracking with Google Maps integration Uses Bootstrap to display the Admin pages: http://getbootstrap.com/ @@ -20,15 +20,15 @@ https://developers.google.com/maps/documentation/embed/get-api-key ## Features -* Stores gps coordinates in a MySQL database, generates xml, and draws markers on to a Google Maps map. -* Draw Paths on the map using the gps entries +* Stores GPS coordinates in a MySQL database, generates XML, and draws markers on to a Google Maps map. +* Draw Paths on the map using the GPS entries * Paths can be colored -* Entries can be linked to paths, to a device, and a device to an owner -* Multiple gps entry types with custom icons +* Entries can be linked-to paths, to a device, and a device to an owner +* Multiple GPS entry types with custom icons * Edit markers on the map view by dragging to new locations -* Shows marker name and comment in small dialog on map view +* Shows marker name and comment in small dialog on the map view * Can have multiple users to admin the system -* Users can easily add new gps points either through the admin interface or using any external client capable of making HTTP GET requests. +* Users can easily add new GPS points either through the admin interface or using any external client capable of making HTTP GET requests. * On Android, it is simple to create a task using the app [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm&hl=en) to generate the requests as desired. * To embed on a webpage: `````` @@ -41,8 +41,8 @@ Example Update URL: ## Important Pages * phpGPS_Settings.php - Settings File -* generateXML.php - Generates xml for use by google maps -* view.php - Displays the map with markers, embeddedable in an iframe +* generateXML.php - Generates XML for use by google maps +* view.php - Displays the map with markers, embeddable in an iframe ## Requirements @@ -54,11 +54,11 @@ Example Update URL: ## Install Instructions -1. Extract php files to webhost +1. Extract PHP files to WebHost 1. Create Database for use by phpGPS -1. Enter database settings and other config in phpGPS_Settings.php or set using environment variables +1. Enter database settings and other configs in phpGPS_Settings.php or set using environment variables 1. Open phpGPS/install/install.php in browser to create the necessary tables -1. Delete the install folder on webhost +1. Delete the install folder on WebHost 1. Login as user admin/admin and change the default admin pass 1. Set up owners, devices, paths, etc as desired and start creating markers @@ -66,7 +66,7 @@ Example Update URL: Requires Vagrant + VM Provider like VirtualBox + Google Maps API Key -* Clone this repo and make sure .sh files use unix line endings LF +* Clone this repo and make sure .sh files use UNIX line endings LF * Set API Key in phpGPS_Settings.php * Run ```vagrant up``` * Connect at `http://localhost` @@ -78,12 +78,12 @@ Requires Vagrant + VM Provider like VirtualBox + Google Maps API Key Dockerfile and Docker-compose configs are included for easy setup on Linux/Mac. Windows + Docker is not as seamless. -Use `docker-compose up` to automatically load a basic mysql server and an apache+php server. -The application is mounted as a volume to allow for modifying php scripts without restarts. +Use `docker-compose up` to automatically load a basic MySQL server and an apache+php server. +The application is mounted as a volume to allow for modifying PHP scripts without restarts. * Install docker and docker-compose if not already present `sudo apt install docker docker-compose` * Clone this repo, ensure Unix line endings are used -* Set api key in shell `export DEV_KEY=1234567890` +* Set API key in shell `export DEV_KEY=1234567890` * Launch with `docker-compose up` * Connect at `http://localhost:8080` * Login with user/password: admin/admin