SlugPings

A live, interactive map where users place markers to ping an event occuring on campus.

Live demo: https://slugpings.herokuapp.com/ (takes ~30 seconds for server to wake up)

Setting up SlugPings

git clone https://github.com/hueyjj/SlugPings
cd SlugPings
npm install

Set up Heroku (command line interface)

• Go to https://devcenter.heroku.com/articles/getting-started-with-nodejs#set-up
• Click on the dropdown arrow next to "Download the Heroku CLI for..."
• Select the option for your operating system
• Download your installer

• Open up a terminal
• Enter the command below to check if Heroku has been installed

heroku --version

Running

cd SlugPings
heroku local web

Developing

cd SlugPings
git checkout dev
heroku local dev

Backend

• Server is hosted by Heroku
• Written in Node.js
• Express.js (network framework)
• Socket.io (chat)
• Moongoose (framework for MongoDB)
• MongoDB (database)
• mLab (server hosting MongoDB)

Frontend

• React/Redux
• Socket.io
• React leaflet
• Bcrypt

Technology Stack

• MongoDB - back-end database
• ExpressJs - back-end framework
• React + Redux - front-end framework
• NodeJS - back-end written on NodeJs engine

APIs

• LeafletJS - OpenStreetMap wrapper library

Libraries

• Font Awesome