Giter Site home page Giter Site logo

mapper's Introduction

Lighthouse Labs Midterm Project - Mapper

Mapper is a web app that allows users to collaboratively create maps which list multiple pinned locations. Similar to Foursquare you can create and save custom maps such as "Best Coffee Shops Around Town" or "Victoria Brewery Tour Stops".

NPM Version GitHub contributors

Table of contents

Usage

Login

To login to Mapper, go to "/users/login" and enter a user's email address with no password.

Navigation

Once logged in you will be able to view all public maps on the site. From here you can navigate to one of the public maps or to your profile. Your profile will contain a list of your maps (all maps you are a contributor on) and you favourite maps.

A user is able to edit any map that they have created or are a collaborator on. Logged in users are also able to favourite any public map to save to their favourites list.

Getting started

Follow the instructions below to get the project up and running on your local machine for development and testing purposes.

Prerequisites

If you don't have Nodejs and npm installed, install them from here.

Installing and Running

In the root directory, install dependencies:

npm i

Fix to binaries for sass:

npm rebuild node-sass

Reset database:

npm run db:reset

Run the server (nodemon is used):

npm run local

Lastly, visit Mapper!

Built with

  • ES6 - Server-side code
  • Nodejs - JavaScript runtime
  • Express - Framework used for API in Node
  • Bootstrap - Front-end framework
  • jQuery - JavaScript library
  • Sass - CSS Preprocessor
  • PostgreSQL - Open source object-relational database
  • Git - Version Control

Known feature quirks

  • Login is for demo purposes only
  • No logout functionality

Feature roadmap

  • Friends - user can maintain a list of friends that they are able to collaborate on maps with. Could set your maps to be public, or shared with friends.
  • Map Categories - add category tags to your maps, search public maps based on categories.
  • Pin Favourites - similar to how users can favourite a map, they can also favourite and filter by individual pins.

Dependencies

  • Node
  • NPM
  • PG
  • Body-parser
  • Cookie-session
  • dotenv
  • ejs
  • Morgan
  • Node-sass-middleware
  • Nodemon

mapper's People

Contributors

jlangy avatar cassidyq avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.