Skip to content

Latest commit

 

History

History
112 lines (87 loc) · 8.96 KB

README.md

File metadata and controls

112 lines (87 loc) · 8.96 KB

GeekTrip

Milestone 2 Project: Interactive Frontend Development - Code Institute

For my second milestone project, I choose to create a site in that would show the top 4 tourist spots in Tokyo, Japan, depending on whether the user was interested in anime and manga, or video games.

Demo

A live demo can be found here

Here is the responsiveness preview: Responsive View

UX

User Stories

As someone who enjoys travel, I want to be able to find interesting locations to visit in Tokyo, Japan.

As a fan of anime and manda, I want to know where in Japan to go to cater to my interest.

As a fan of video games, I want to be able to find locations that pertain to video games.

As someone who enjoys aesthetics, I want to view a sight that is both pleasing to the eye and on brand for the theme of "geeks" and "nerds".

Strategy

Tokyo is large city, known for many things such as food, fashion, technology, culture, etc. Through this milestone, I wanted to facilitate more specific interests and tailor the search for tourist spots to somewhat niche subjects. Therefore, my goal was to build a website that allowed the user to easily and swiftly find tourist pots in Tokyo, Japan, related to video games or anime and manga.

I wanted to keep the site quite basic, hence the choice of 3 sections, so as not to detract from purpose and design. The utilization of 3 sections helps to build narrative of the site and its purpose in the user's mind, and I feel that greatly aids in yielding more potent user story.

Scope

The purpose of this project was built a wesite that would show the suer the top 4 tourist spots in Tokyo, Japan, depending on whether they were interested in anime and manga or video games.

This project was also an opportunity for me to display my skill in HTML, CSS, and JS, as well as showcase a my comptentence with the utilisation of APIs, particularly the Google Maps API and the one from EmailJS.

Surface

Given that the project is centered upon Tokyo, and its prevailing themes are anime, manga, and video games, I wanted an aesthetic that would remain "on brand". Tokyo, particularly its gaming and tech scene, is known for its neons and flashing lights. I wanted to incoprate that element into the site's design while preventing them from being too overpowering. Therefore, I opted for carefuly curated, theme-related images as background for the first and lst pages, separated by a respectable portion of black space on the second page, to break up the wall of colour and prevent the aeshetic from being too jarring.

Skeleton

  • Landing Page (which contains the about info for more efficient use of screen space)
  • Search Mape
  • Contact

Structure

Here are a list of the wireframes I developed for this project using Balsamiq.

Features

  • I opted to use a single page format to make navigation much simpler and intuitive, meaning the user doesn't need to click back and forth between pages.
  • The default setting for the navbar seemed to create a very stark and jarring transition to whatever you clicked on. It wasn't a very smooth effect. So, I opted for a smooth scrolling effect instead of just appearing on whatever navbar item you click on, and this made for a much nicer, more fluid experience.
  • I used marker clustering with the map markers to make it easier to view and interact with markers that were placed very clsoe together.
  • I created the footer to mirror the navbar in design, being black. This made for a very balanced and symmetrical visual experience when both were present and visible on the screen.
  • I included social media links in the footer and added a small rotation and colour changing animation to help enhance their visibility and presence.

Features left to implement

  • I attempted to add a form validator to ensure no blank fields could be submitted in contact form, and I also attempt to create a fucntion that would clear the form upon submission for better UX. However, they didn't seem to work for me. In the future, I'd like to work on that a bit more and implement those features
  • I would like to include button interaction to the contact form button so that it does somethign or changes somehow when pressed so that the user can be sure they pressed the button. This would be better from a UI/UX perspective, and I hope to implement that in the future.
  • I would like to create a fucntion that creates a prompt upon submission to inform the user that their submission was successful.

    Technologies Used

    • Visual Code Studio - code editor used for this project.

    • HTML - to create the structure of the project and define the "skeleton", so to speak.

    • CSS - to design and style the project, adding the "flesh to the skeleton", so to speak

    • Bootstrap - used as a framework to make design faster and easier.

    • Git - used for version control.

    • Font Awesome - used for social media icons.

    • HTML Formatter - used to beautify html.

    • CSS Formatter - used to beautify css.

    • Am I Responsive? - used to test responsiveness.

    • JavaScript - used with Bootstrap.

    • JQuery - used to support Java Script.

    Additional resources and tools

    Testing

    The first step of my testing began by using Am I Responsive? to deduce whether my project was indeed responsive and compatible across all devices, the results of which can be observed at the beginning of this readme in the responsiveness preview.

    The second stage involved sharing the deployed link with a few colleagues and friends to double check whether it was actually responsive or not.

    The third step of my testing involved passing my JavaScipt code through Jshint, and I had no major issues.

    The fourth step of my testing involved the utilization of Code Verifier, the result of which had no errors, but 4 warnings as seen here: Warninggs

    It is worth noting that 3 of the 4 warnings are from code provided by the EmailJS doc on how to create their contact forms.

    Deployment

    This site is hosted on GitHub pages and it's deployed directly using the master branch. The deployed site will update automatically when new commits are made and then pushed from VSCode. To deploy the site correctly, the landing page must be named 'index.html'.

    To run locally, you can clone this repository directly into the editor of your choice by pasting git clone https://github.com/kel151/milestone2.git into your terminal. To cut ties with this GitHub repository, type git remote rm origin into the terminal.

    Credit

    Content

    All of text in the "About" section was written by me.

    Media

    The images used in this project were taken from Unsplash, an open license and highly customizable resource that I greatly recommend.

    Acknowledgements

    • My mentor, Aaron Sinnot, for all of his patience, advice, and recommendations.
    • My friend and fellow member of the Code Institute Slack Community, Mia, for all of her advice, kindness, and encouragement.
    • The Student Care team, particularly Claire Lally, for the constant support, encouragement, and check-in messages.
    • The Code Insitute tutpring team (particularly Michael, Samantha, Scott, Xavier, and Tim) for their patience perpetual willingness to help, no matter how late.

    This is for educational use.