Merge pull request #1804 from nquinlan/master

create a serverless version, closes #1766, #1732, #1663

Author: nquinlan

.env.example

@@ -1,2 +1 @@
-PORT= # Port to be used by the app
 GOOGLE_API_KEY= # Google Maps API KEY

.github/workflows/geocode.yml

@@ -0,0 +1,18 @@
+name: geocode-new-addresses
+on:
+  push:
+    branches:
+      - master
+jobs:
+  geocode:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - run: npm install; npm run geocode
+        env:
+          GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Geocoded newly added addresses
+          commit_author: MLH Localhost <localhost@mlh.io>

README.md

@@ -14,28 +14,24 @@ This repository contains the source code for a map of the hometowns of anyone wh
 
 ## Technologies used in this project
 
-### NodeJS
+### [GitHub Actions](https://github.com/features/actions)
+GitHub actions allows us to run a [NodeJS script](#nodejs) automatically when a commit is pushed to the project. That script takes all the locations provided and turns them into latitude & longitude coordinates.
 
-The map itself is a Node.js application. Node.js allows us to write full-stack
+### [GitHub Pages](https://pages.github.com/)
+GitHub pages lets us host our map on GitHub as a webpage.
 
-## NPM packages used
+### [NodeJS](https://nodejs.org)
 
-### [express](https://www.npmjs.com/package/express)
+We chose to use NodeJS as the language to turn all the hometown names into coordinates. 
 
-Fast, unopinionated, minimalist web framework for node. This is the framework with which we built the application.
-
-### [dotenv](https://www.npmjs.com/package/dotenv)
+#### [dotenv](https://www.npmjs.com/package/dotenv)
 
 Dotenv is a zero-dependency module that loads environment variables from a `.env` file into `process.env`. Storing configuration in the environment separate from code is based on The Twelve-Factor App methodology.
 
-### [node-geocoder](https://www.npmjs.com/package/node-geocoder)
+#### [node-geocoder](https://www.npmjs.com/package/node-geocoder)
 
 Node library for geocoding and reverse geocoding.
 
-### [ejs](https://www.npmjs.com/package/ejs)
-
-Embedded JavaScript templates
-
 ## Try the application locally, if you want!
 
 ### Google Maps API Key
@@ -56,8 +52,6 @@ Japan
 
 To add a new location, simply append a new line to the locations.txt file
 
-There is also a `locations.txt.example` file that can be used to test the app. Copy its content to locations.txt and restart the app.
-
 ## Running the application:
 
 To run this application locally, you'll need to:
@@ -75,14 +69,19 @@ npm install
 There is a `.env.example` file that can be used to configure the app. Simply create a copy named `.env`
 
 ```txt
-PORT= # Port to be used by the app
 GOOGLE_API_KEY= # Google Maps API KEY
 ```
 
-Now inside the root folder run:
+Now inside the root folder run the following:
 
 ```
-npm start
+npm geocode
 ```
 
-Now you can access locally in your browser the address `http://localhost:3000` and see your locations map.
+This will turn each line in the `locations.txt` into a set of coordinates.
+
+You can see your own map by running:
+
+```
+npm start
+```