Initial Commit

Author: JamieMLH

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Major League Hacking (MLH)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+# Participants' Home Towns
+
+## Tecnologies used in this project
+
+## NodeJS
+
+Node.js is a platform built on Chrome's JavaScript runtime for easily building fast and scalable network applications. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient, perfect for data-intensive real-time applications that run across distributed devices. NodeJS was the platform in which we built this application.
+
+## NPM packages used
+
+### [express](https://www.npmjs.com/package/express)
+
+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 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 library for geocoding and reverse geocoding.
+
+### [ejs](https://www.npmjs.com/package/ejs)
+
+Embedded JavaScript templates
+
+## Prerequisites to run this application:
+
+### 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.
+
+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:
+
+```txt
+New York, USA
+Brazil
+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:
+
+* Clone this repository:
+```
+git clone https://github.com/MLH/localhost-github.git
+cd localhost-github
+npm install
+```
+
+* 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
+```
+
+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.

index.js

@@ -0,0 +1,2 @@
+const server = require("./src/server");
+server.start();

locations.txt

@@ -0,0 +1,16 @@
+New York, USA
+Tokyo, Japan
+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

package.json

@@ -0,0 +1,32 @@
+{
+  "name": "maps",
+  "version": "1.0.0",
+  "description": "display participant locations in a map",
+  "main": "server.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "scripts": {
+    "start": "node index.js"
+  },
+  "engines": {
+    "node": "10.x"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MLH/localhost-github.git"
+  },
+  "author": "Halisson Bruno",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MLH/localhost-github/issues"
+  },
+  "homepage": "https://github.com/MLH/localhost-github#readme",
+  "dependencies": {
+    "dotenv": "^6.2.0",
+    "ejs": "^2.6.1",
+    "express": "^4.16.4",
+    "morgan": "^1.9.1",
+    "node-geocoder": "^3.22.0"
+  }
+}

src/addresses.js

@@ -0,0 +1,17 @@
+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');
+  return String(fileContent).split("\n");
+}
+
+function getExampleAddresses() {
+  return [];
+}
+
+module.exports = {
+  getAddresses,
+  getExampleAddresses
+};

src/locations.js

@@ -0,0 +1,25 @@
+const fs = require("fs");
+const NodeGeocoder = require("node-geocoder");
+
+var options = {
+  provider: "google",
+  httpAdapter: "https",
+  apiKey: process.env.GOOGLE_API_KEY,
+};
+
+var 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;
+}
+
+module.exports = {
+  getLocations
+};

src/server.js

@@ -0,0 +1,38 @@
+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 || 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.");
+  const addresses = await Addresses.getAddresses();
+  console.info(
+    "Converting addresses into locations. Please notice this may take a while if there are many addresses..."
+  );
+  const locations = await Locations.getLocations(addresses);
+  console.info("Starting application");
+  app.get("/", function(req, res) {
+    res.render("index", {
+      locations,
+      apiKey: googleMapsApiKey,
+    });
+  });
+
+  app.listen(PORT, function() {
+    console.log("Maps app listening on port " + PORT);
+  });
+};
+
+module.exports = {
+  start
+};