Giter Club home page Giter Club logo

lhl-midterm's Introduction

MapMyWiki

MapMyWiki is geo-wiki type application created for LightHouseLabs.ca mid-term project to exercise our skills to date in the course including front and back end scripting in Javascript, Postgress SQL, HTML and CSS (via SASS).

MapMyWiki is a joint development effort between

  • Ernie Johnson (front: layout/css & interfacing to backend)
  • Atsuyuki Yoshimatsu (backend: server & sql development)

Screen Shot of Top Page


Contents...

  1. Getting Started
  2. Features
  3. Future Plans
  4. Detailed Operation
  5. Known Bugs
  6. Database
  7. Attributions
  8. Updates

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: midterm

labber must have all GRANT of operation on midterm.

  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/ in your web browser

Features...

  • Users can create and share maps/private maps
  • Users can create and share pins on maps
  • Users can not edit private maps (owned by someone else) Screen Shot of Top Page ( back to top ๐Ÿ”บ)

Future Plans...

  • allow additional sorting of any displayed results
  • allow map owner to style their app with custom backgrounds and icons
  • allow more map interfacing such as "directions to"
  • improve map point management system for 100's of points
  • style entire project for responsive design: mobile to desktop
    ( back to top ๐Ÿ”บ)

Known Bugs...

  • Vertical scroll bar is forced 'always' on' to prevent page shifts when data exceeds bottom of viewable space.
  • This application has been tested on Windows 11 via WSL, Ubuntu Linux 21.10, and MacOS 16 Ventura. All platforms tested with Chrome and Firefox browsers. Please report any bugs found!
    ( back to top ๐Ÿ”บ)

Database ERD...

"Screenshot of ERD"

Attributions...

  • conColors (misc. functions)
  • conColors (misc. CSS for dark mode template)
  • FontAwesome (various icons)
  • Google Fonts, Google Maps API
  • Ajax
  • Node.js
  • PostgreSQL
  • SCSS (CSS)
  • ExpressJS
  • JQuery
  • bcrypt
  • cookie-session
  • dotenv
  • morgan
  • eslint
  • nodemon ( back to top ๐Ÿ”บ)

Updates...


lhl-midterm's People

Contributors

atyoshimatsu avatar ej8899 avatar

Stargazers

 avatar

Watchers

 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.