ESL Project.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
CNAME
LICENSE.txt
README.md
index.html
map_controller.js
master_interface.css

README.md

ESL Map

This project provides the power for the ESL Map.

It uses a simple Google form to gather the data, and gets the data for display by calling the Google spreadsheet json endpoint. It's hosted here on Github Pages, and requires only Github and Google accounts, both of which are free.

Contributing

# optionally, install handy webserver to use in dev
npm install -g live-server

# clone the repo
git clone https://github.com/mnhrc/mnhrc.github.io

# do work
cd mnhrc.github.io
live-server . # or your preferred method for hosting local frontend projects

Please open a Pull Request to submit your changes.

Please open an Issue (with screenshots and/or sample code and error messages) to report bugs or other problems.

Deploy for Your Locale

If you'd like to repurpose this app for your area, you'll need to make changes to the client code and provide your own infrastructure (Google Form, Google Sheet, hosting).

Enable Google Sheets API

Requirements

  • Google account

Steps

  1. Go to Google Developers Console
  2. Go to Library (left sidebar nav)
  3. Search for Sheets in the API library and open the link to the Google Sheets API console
  4. Enable the Sheets API (see the Enable button)
  5. Go to Credentials (left nav)
  6. Click Create Credentials and create an API key
  7. Copy the API key and close the dialogue
  8. Click on the name of the API key in the table to view the config screen for the key
  9. Under the Key restriction heading, select the HTTP Referres (web sites) option
  10. Add the domain on which you'll be hosting the app (and from which the client api library will be making ajax requests)
  11. Optionally, add your local dev address (http://localhost:8080 or what have you)
  12. You should remove that dev alias after you finish working and deploy

You should now have an API key scoped to the domains on which the client code will run, and you should have enabled the Google Sheets API for your account.

Create Google Form and Google Sheet

Requirements

  • Google account

Steps

Rather than describe the schema of the form and resultant spreadsheet, link to examples here.

Update Client Code

Requirements

Steps

  1. Locate and replace the API key in the client codebase
  2. Locate and replace spreadsheet ID in client codebase
  3. Locate and replace the center lat and lng values to define the initial center point of the map on load

As of this writing, all of these values are kept at the top of the map_controller.js file for ease of access.

Deploy to Host of Choice

The application is completely contained as a simple website and requires only to be hosted as such.

For example, we host it for free on Github Pages.