Skip to content

Map-based event sharing web application designed to connect local communities

License

Notifications You must be signed in to change notification settings

colleenDunlap/Lake-Map

Repository files navigation

Lake-Map

Map-based web application that connects users from around the world through event sharing!




Background

Forked from https://github.com/sahat/hackathon-starter/

This web application has a Node.js/Express backend with a Jade front-end. A MongoDB database is used for all data storage/retention. The Google Maps API is utilized for creating the map, the clickable pins, etc.

Project Structure Breakdown

Name Description
config/passport.js Passport Local and OAuth strategies, plus login middleware.
controllers/api.js Controller for /api route and all api examples.
controllers/contact.js Controller for contact form.
controllers/home.js Controller for home page (index).
controllers/user.js Controller for user account management.
models/User.js Mongoose schema and model for User.
public/ Static assets (fonts, css, js, img).
public/js/application.js Specify client-side JavaScript dependencies.
public/js/main.js Place your client-side JavaScript here.
public/css/main.scss Main stylesheet for your app.
public/css/themes/default.scss Some Bootstrap overrides to make it look prettier.
views/account/ Templates for login, password reset, signup, profile.
views/api/ Templates for API Examples.
views/partials/flash.pug Error, info and success flash notifications.
views/partials/header.pug Navbar partial template.
views/partials/footer.pug Footer partial template.
views/layout.pug Base template.
views/home.pug Home page template.
.env.example Your API keys, tokens, passwords and database URI.
app.js The main application file.
package.json NPM dependencies.
yarn.lock Contains exact versions of NPM dependencies in package.json.
buildme.sh Run this bash script to set up database, start web app
mongod Bash script that starts the mongo daemon on Cloud9 hosting