Update syntax to be more clear

Author: Niko

.env.example

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

.gitignore

@@ -2,3 +2,4 @@
 package-lock.json
 
 .DS_STORE
+.env

README.md

@@ -1,4 +1,5 @@
 # MLH Localhost Hometown Map
+
 This repository contains the source code for a map of the hometowns of anyone who attends the MLH Localhost workshop, How to Collaborate on Code Projects with GitHub. Participants learn best practice GitHub workflows, add their hometown to `locations.txt`, and see the giant community they're part of!
 
 ## How to participate in this workshop
@@ -39,11 +40,10 @@ Embedded JavaScript templates
 
 ### Google Maps API Key
 
-To use the Google Maps JavaScript API, you will ned an API Key.  The [API key](https://developers.google.com/maps/documentation/javascript/get-api-key) is used to track API requests associated with your project for usage and billing. To learn more about API keys, see the API Key Best Practices and the FAQs.
+To use the Google Maps JavaScript API, you will ned an API Key. The [API key](https://developers.google.com/maps/documentation/javascript/get-api-key) is used to track API requests associated with your project for usage and billing. To learn more about API keys, see the API Key Best Practices and the FAQs.
 
 Read the [tutorial](docs/tutorial.md) and configure your [API Key](https://developers.google.com/maps/documentation/javascript/get-api-key)
 
-
 ## Adding a new location
 
 The App reads its locations from the `locations.txt` file located in the root folder. It will consider each line a different location, so the file should look something like this:
@@ -62,25 +62,27 @@ There is also a `locations.txt.example` file that can be used to test the app. C
 
 To run this application locally, you'll need to:
 
-* Clone this repository:
+- Clone this repository:
+
 ```
 git clone https://github.com/MLH/mlh-localhost-github.git
 cd localhost-github
 npm install
 ```
 
-* Set up environment variables:
+- Set up environment variables:
 
 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
-API_KEY= # Google Maps API KEY
+GOOGLE_API_KEY= # Google Maps API KEY
 ```
 
 Now inside the root folder run:
+
 ```
 npm start
 ```
 
-Now you can access locally in your browser the address  `http://localhost:3000` and see your locations map.
+Now you can access locally in your browser the address `http://localhost:3000` and see your locations map.

locations.txt

@@ -1,170 +1,85 @@
 Illinois, United States of America
-
 Goa, India
-
 Tehran, Iran
-
 Jalandhar, India
-
 Gatineau, Canada
-
 Lincoln, Pennsylvania
 Changchun, China
 Phoenix, Arizona
-
 Mississauga, Canada
-
 Lake Hiawatha, New Jersey
-
 Denver, Colorado
-
 Moscow, Russia
-
 Milwaukee, Wisconsin
-
 New York, USA
-
 Paris, France
-
 Montreal, Canada
-
 Goiania, Brazil
-
 Vienna, Austria
-
 Melbourne, Australia
-
 Osaka, Japan
- 
 Calgary, Canada
-
 Sydney, Australia
-
 Vancouver, Canada
-
 Toronto, Canada
-
 Tokyo, Japan
-
 Copenhagen, Denmark
-
 Adelaide, Australia
-
 Miami, Florida
-
 Tulsa, Oklahoma
-
 Queens, Ny
-
 Bavaria, Germany
-
 Jamaica, New York
-
 Ambato, Ecuador
-
 Binghamton, New York
-
 South Ozone Park, New York
-
 Queens, New York, USA
-
 New York, New York
-
 Santiago, Dominican Republic
-
 Seattle, Washington
-
 Gopaltila, Sylhet, Bangladesh
-
 Manila, Philippines
-
 Cali, Colombia
-
 Brooklyn, New York
-
 Long Island City, New York
-
 Kowloon, Hong Kong
-
 Irvington, New Jersey
-
 Parsippany, New Jersey
-
 Haworth, New Jersey
-
 Dhaka, Bangladesh
-
 Huntington, New York
-
 New York, NY
-
 Rockville, Maryland
-
 Sylhet, Bangladesh
-
 Hanmer, Canada
-
 Forks of Salmon, California
-
 Ahmedabad,India
-
-simla,india
-
+Simla,india
 Vadodara, India
-
 Nakuru, Kenya
-
 Anand,India
-
 Patuakhali, Bangladesh
-
 Ajax, Canada
-
 Toronto, Canada
-
 Burlington, Canada
-
 Fontainebleau, France
-
 Barisal, Bangladesh
-
 Bagerhat, Bangladesh
-
 Kingston, Canada
-
 Trichy,India
-
 Reading, Pennsylvania
-
 Mysore, India
-
 San Antonio, Texas
-
 Plano, Illinois
-
 Ciudad de Guatemala, Guatemala
-
 Daegu, South Korea
-
 Ho Chi Minh City, Vietnam
-
 St. Catharines, Canada
-
 Dzerzhinsk, Russia
-
 Streamwood, Untied States of America
-
 Quincy, Illinois
-
 Oswego, Illinois
-
 Maple Park, Illinois
-
-Maple Park, Illinois
-
 Elgin, Illinois
-
-Warrenville, IL 
-
+Warrenville, IL
 Grayslake, Illinois
-

package.json

@@ -1,7 +1,7 @@
 {
   "name": "maps",
   "version": "1.0.0",
-  "description": "display participant locations in a map",
+  "description": "Display participant locations in a map",
   "main": "server.js",
   "directories": {
     "doc": "docs"
@@ -16,7 +16,7 @@
     "type": "git",
     "url": "git+https://github.com/MLH/localhost-github.git"
   },
-  "author": "Halisson Bruno",
+  "author": "Major League Hacking",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/MLH/localhost-github/issues"

src/addresses.js

@@ -2,14 +2,14 @@ const fs = require("fs");
 
 const DEFAULT_FILE_PATH = "../locations.txt";
 
-async function getAddresses(filePath = DEFAULT_FILE_PATH) {
-  const fileContent = await fs.promises.readFile('locations.txt');
+const getAddresses = async function(filePath = DEFAULT_FILE_PATH) {
+  const fileContent = await fs.promises.readFile("locations.txt");
   return String(fileContent).split("\n");
-}
+};
 
-function getExampleAddresses() {
+const getExampleAddresses = function() {
   return [];
-}
+};
 
 module.exports = {
   getAddresses,

src/locations.js

@@ -1,24 +1,29 @@
 const fs = require("fs");
 const NodeGeocoder = require("node-geocoder");
 
-var options = {
+const options = {
   provider: "google",
   httpAdapter: "https",
   apiKey: process.env.GOOGLE_API_KEY,
+  sensor: true
 };
 
-var geocoder = NodeGeocoder(options);
+const geocoder = NodeGeocoder(options);
 
-async function getLocations(addresses) {
-  const locations = await geocoder
-    .batchGeocode(addresses)
-    .filter(({ error }) => !error)
-    .map(({ error, value: [result, ...results] }) => ({
-      lat: result.latitude,
-      lng: result.longitude
-    }));
-  return locations;
-}
+const getLocations = async function(addresses) {
+  try {
+    const locations = await geocoder
+      .batchGeocode(addresses)
+      .filter(({ error }) => !error)
+      .map(({ error, value: [result, ...results] }) => ({
+        lat: result.latitude,
+        lng: result.longitude
+      }));
+    return locations;
+  } catch (error) {
+    console.error(error);
+  }
+};
 
 module.exports = {
   getLocations

src/server.js

@@ -2,32 +2,31 @@ require("dotenv").config();
 const express = require("express");
 const morgan = require("morgan");
 const path = require("path");
+
 const Addresses = require("./addresses");
 const Locations = require("./locations");
 
 const app = express();
-const PORT  = process.env.PORT || 3000;
+const PORT = process.env.PORT || 3000;
 const googleMapsApiKey = process.env.GOOGLE_API_KEY;
 
 app.use("/static", express.static("static")); // Exposes static folder to serve images and styles
 app.use(morgan("combined")); // Logs requests
 app.set("view engine", "ejs"); // Set default view engine
 
 const start = async function() {
-  console.info("Loading addresses.");
+  // Let's load the addresses for the map.
   const addresses = await Addresses.getAddresses();
-  console.info(
-    "Converting addresses into locations. Please notice this may take a while if there are many addresses..."
-  );
+
+  // Let's convert these addresses into locations.
   const locations = await Locations.getLocations(addresses);
-  console.info("Starting application");
+
+  // We need to define the basic route for our application.
   app.get("/", function(req, res) {
-    res.render("index", {
-      locations,
-      apiKey: googleMapsApiKey,
-    });
+    res.render("index", { locations, apiKey: googleMapsApiKey });
   });
 
+  // We start the application by listening to the defined PORT.
   app.listen(PORT, function() {
     console.log("Maps app listening on port " + PORT);
   });