Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 2.57 KB

README.md

File metadata and controls

75 lines (55 loc) · 2.57 KB

Wiki Map

Version 1.0.0

Welcome to Wiki Map, an application where you may create customized maps with waypoints (also called pins) based on your personal interests or tastes. Anyone may explore Wiki Map's collection, and you may register to create your own maps, share your contributions into other maps, and create a list of favourite maps, so you may visit and explore them quickly.

Final Product

Wiki Map is designed to perform in mobile devices, tablets and desktops. Its layout can adapt responsively depending on the device you may be using.

Mobile presentation Tablet presentation

Desktop presentation

You may navigate any map or visit user profiles as a visitor, but you must be a registered user with a valid User to be able to create maps, contribute, and bookmark (favourite) any maps that feel special to you.

Visitor visualization(map list)

User profile(user)

Pin visualization(visitor)

You may also manage, delete and edit any maps and points that you have created. If you created a map, you may manage all points in your map.

Pin visualization(map or pin owner)

Technologies Information/Stack

  • JavaScript
  • jQuery
  • Bootstrap 4.5
  • EJS
  • AJAX
  • Node.js
  • Express
  • SASS
  • PostgreSQL
  • Leaflet.js
  • Maptiler
  • Mapquest
  • Font Awesome

Dependencies

  • Node 10.x or above
  • NPM 5.x or above
  • PG 6.x
  • bcrypt
  • body-parser
  • chalk
  • dotenv
  • pg and pg-native
  • request and request-promise-native
  • Node SASS-middleware
  • Express
  • Nodemon
  • EJS

Getting Started

  1. Create the .env by using .env.example as a reference: cp .env.example .env
  2. Update the .env file with your correct local information
  • username: labber
  • password: labber
  • database: wikimap
  1. Install dependencies: npm i
  2. Fix to binaries for sass: npm rebuild node-sass
  3. Reset database: npm run db:reset
  • Check the db folder to see what gets created and seeded in the SDB
  1. Run the server: npm run local
  • Note: nodemon is used, so you should not have to restart your server
  1. Visit http://localhost:8080/