Skip to content

djpotts21/Northumbrian-Beauty

Repository files navigation

The Beauty of Northumberland

Our web application aims to provide an immersive experience for tourists and visitors to Northumberland by combining various features. Utilizing Google Map markers, the application showcases the breathtaking beauty spots scattered throughout the Northumberland region. Users can explore these spots by accessing detailed information. Additionally, Places to Stay via Airbnb allows users to conveniently find and book hotels and accommodations in the surrounding area.

Purpose

Northumberland is a vast county, there are lots of attractions that we as local residents know about, however unless you stumble across an open Tourist Information Center or navigate the Tourism Website which gives you an overview per town.

The overall purpose is to create an interactive map where users can zoom in, click and see information about each attraction, providing the function to zoom in and out of the surrounding areas so the user is able to find the attractione easily. By providing images to the user within the marker data and on the corrosponding list data the user is able to visually compare the image of the venue to that in real life.

The use concept and target market is for users primarily tourists to have this as a webpage on their mobile device so they can look at data in an easy and simple format, interact with the map live and see the attraction data in a simple format. However on the desktop the same information is extended in to list views.

Scope of work

Project Goals

1. A responsive website is available on all devices.
2. The website should be easy to read for all users.
3. The website should be one page that uses Javascript to update the page with information relevant to the buttons clicked.
4. The website should compliment the colors of the Northumberland Flag (Pantone and HEX colors are detailed below).

Deliverables

Default View (Home)

This view should consist of a map taking out 80% of the page, a Logo / Nav Bar at the top, and a footer at the bottom. The home view will also consist of an introductory / helper description which appears as an overlay to the map.

Content View (Map Sub Sections)

This view should consist of a map taking out 80% of the page, a Logo / Nav Bar at the top, and a footer at the bottom. The view should also include a right sidebar which is expandable and collapsable and displays the contents of the map in list form.

Wireframes

Desktop

Mobile

Tablet

Finished Project Views

Desktop

Mobile

Tablet

Finished Project URL

Available on GitPages at the following URL https://djpotts21.github.io/Northumbrian-Beauty/

Testing

Javascript Built-in Testing

This app uses built-in testing by Jest. The test suite is located in the assets/js/tests folder named script.test.js

This test script checks each array of data in the main script has data and is correctly formated to prevent future addtions to the array being incorrectly formated and as such returnin incorrect or inaccurate data to the user.

To run the test and deploy the site to the server environment, uncomment line 341 of the assets/js/script.js file which starts "module.exports..." then run "npm test" in your terminal window.

Our results - The npm test was run and the screenshots saved are located here > /assets/images/test-results/npmtestresults.png

Javascript External Testing

The javascript was tested using the validator service at beautifytools.com https://beautifytools.com/javascript-validator.php, the results show the errors which are from the Google provided code and I suspect it is being caused due to the imported scripts not being loaded. > Added to known bugs. The results in screenshot format are located here

HTML External Testing

The html was tested using the validator service at w3.org https://validator.w3.org/nu/#textarea the results in screenshot format are located here > /assets/images/test-results/htmlresults.png

CSS External Testing

The css was tested using the validator service at w3.org https://jigsaw.w3.org/css-validator/#validate_by_input the results in screenshot format are located here > /assets/images/test-results/cssresults.png

Authors

Acknowledgements

Location Information

Blurb / Description

All location blurbs/descriptions are snippets of text taken from each website linked to the location.

Images

A photo of The Fish Shack (Places to eat, Location 1) is provided by Boathouse Food Group at the following URL https://www.boathousefoodgroup.co.uk/wp-content/uploads/2017/10/fish-shack-01-1400x860.jpg

Color Reference

Color Hex
Northumberland Flag (Red) #DA291C
Northumberland Flag (Yellow) #FFD100