Skip to content

Modified version of placemark hapi app to serve as API backend for Placemark-App

Notifications You must be signed in to change notification settings

chipspeak/placemark-api-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Placemark - POI

Placemark is a web application and API for adding and categorising outdoor points of interest. This application was created for a Full Stack Development module on the HDip in Computer Science at SETU.

Features

  • Create, view, update and delete placemarks via the application or API
  • Add and update images to the placemarks for viewing within the application
  • Added placemarks are viewable on a map at the bottom of the dashboard with images features when clicking on the placemarks
  • Users can view placemarks in their entirety on the dashboard or by category using the appropriate tab and selection
  • The administrator can view all current users and analytics relating to their placemarks in addition to deleting users as needed

User guide

  1. Sign up and log in to view your dashboard. To view some of the seeded sample placemarks you can log in using the following details email: "homer@simpson.com" password: "secret".

  1. Placemarks are expanded by default and within the expanded view you can see the placemark's details. Initially, there won't be an image but click the camera icon to upload one and add it to the placemark

  1. You can collapse the placemark card if you find your dashboard becoming too cluttered. Click the arrow to collapse the card. You can also collapse the images once they've been added by clicking the arrow above them.

  1. When you first log in, you'll be presented with the add placemark form by default. Once a placemark has been added, the dashboard view will expand to feature a map with the placemark displayed at its location. Clicking on the placemark will show its title (and image if it has one). The Map defaults to a wide view of Ireland but you can freely adjust its position and level of zoom.

  1. Clicking the API tab or adding "/documentation" to the website URL will redirect to the API documentation where you can view all of the available methods, schemas and examples. Certain actions, such as deleting all users and placemarks, are locked behind Admin privileges. The other methods are available to try out within the swagger interface however most require token authentification. To do this, simply create a user, then pass the new user's credentials to the authenticate method. You can then log in using the returned token with the authorize button in the top right of the screen.

Technologies Used

  • JavaScript
  • Hapi
  • Node
  • Handlebars
  • JOI
  • JWT
  • LowDB
  • Mongoose
  • Cloudinary
  • Heroku
  • Axios
  • Chai
  • ESLint
  • Nodemon
  • Bulma
  • Font Awesome
  • Mocha
  • Chai
  • Glitch

Website URL

https://placemark-poi.glitch.me/

About

Modified version of placemark hapi app to serve as API backend for Placemark-App

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published