Giter Site home page Giter Site logo

somekindofdesign / two-dogs Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 1.0 38.34 MB

A blog site built using HTML and CSS for the Code Institute Project-1.

Home Page: https://somekindofdesign.github.io/two-dogs/

Dockerfile 4.72% CSS 17.47% HTML 77.81%
code-institute css3 html5 project-1

two-dogs's Introduction

Welcome to Two Dogs!

Two Dogs is a blog site that hopes to bring light-hearted and entertaining content by showcasing events in the life of the Two Dogs - Wreckless Eric and Baby Jim. It includes stories, images and videos about what they get up to in their day-to-day life.

The live site can be found here


two dogs blog on desktop, laptop and mobile devices Image by Freepik


Audiences

The target audience for this site is consumers of online entertainment with a cross section of dog-lovers. It's primary source of traffic will be through social media channels. If the site is successful, it is expected that a portion of users will come from signing up to the blog.

It is anticipated that due to the nature of the site, users will predominatly use their mobile phone to use the Two Dogs site. This should be verified as the site gathers traffic.

    User Stories
  • As a dog lover and online content consumer I want to view content relating to dogs online
  • As a dog lover and online content consumer I want to view content relating to the two dogs, Wreckless Eric and Baby Jim
  • As a fan of the Two Dogs blog, I want to keep up to date with the latest blog posts through email

Features

The first release of the Two Dogs site includes several vital features which are detailed below. Future releases should include additional features as outlined in the 'Features Left to Implement' section.


Existing Features

The navigation bar

Featured on all pages, this fully responsive navigation includes links to the landing page, the meet page, the tails blog page, the gallery and the blog sign up page. It is exactly replicated across the site to ensure consistency for the user.

The navigation allows users to browse the site from any page without having to use the back button on their device.

It uses code from Medium.com (futher details in Credits section below). This particular piece of code was used as it included consideration for users of screen readers, increasing the reach of the accessibility of the site.

two dogs website header on desktop

two dogs website header on mobile

two dogs website nav menu open on mobile


The landing page hero image

The landing page opens up to an image of the two dogs, enticing the user to explore the site further and find out more about them. The image has a slight zoom to help focus the user on the call-to-action, beginning their journey on the site.

two dogs website hero section on desktop


The footer

The footer includes links to relevant social media sites, opened in new tabs to avoid taking the user away from this site.

two dogs website hero section on desktop


The meet page

The meet page introduces users to the Two Dogs and allows them to learn some basic facts about their history and personality including likes and dislikkes. This is important in building interest with the audience.

two dogs website meet page on desktop


The tails blog

The Tails Blog houses blog posts giving detailed stories about the Two Dogs lives. Users will find written content, images and videos updated frequently here. This is the main focus of the website and will grow over time as new content is added.

two dogs website meet page on desktop


The gallery

The gallery contains visual content of the dogs including from the Tails blog posts and completely new content. It supports the core feature of the site, the blog.

two dogs website meet page on desktop


The sign up page

The sign up page includes a sign up form that allows users to opt in to periodical emails containing the latest stories from the Two Dogs lives. Users are in control of the frequency of the emails received. To encourage users to sign up, there is a call-to-action in the form of a banner throughout the site.

two dogs website meet page on desktop

two dogs website meet page on desktop


Features Left to Implement

  • CMS for adding and organising blog posts and image/video content
  • Automated emails to subscribed users with optional daily, weekly or monthly updates
  • Comments and social sharing on blog posts
  • Improved image delivery for better quality, responsive and optimised performance
  • Implement custom 404 page (page has been built in this release, implementation blocked by git restrictions)

Testing

Throughout the development of this site, testing was carried out on different devices using the developer tools on multiple browsers including Chrome, Firefox and Microsoft Edge on Windows 10.

This was repeated towards the end of the project using the free testing tool on BrowserStack.com, while extending the reach of testing to other Windows OS, the browser Safari and multiple MacOS. It is worth noting that as this is a free tool, the accuracy of the tests may be limited.

For all testing, each page was reviewed across the following criteria;

  • Layout and positioning (ie is everything where it's expected to be on all devices)
  • Functions (ie buttons, links, inputs, etc)
  • Features (ie image rendering, form fill and submission, etc)
  • Consistency, convention and expectation (ie does it allow affordance to the user)


The site was evaluated by Google's Lighthouse and Page Speed tools. As performance is not optimal, improvements were investigated such as using webp images or minfying the CSS. Both resulted in the score lowering even further, by as much as 10 points in the case of the image file type. In place of the recommendations from Google this release uses source sets and mulitple css files, resulting in marginal improvements from the first audit. Further investigation into the recommended changes should take place for future releases.


Lighthouse

  • Performance - 77
  • Accessibility - 100
  • Best Practices - 100
  • SEO - 100

Page Speed

  • Mobile - 77
  • Desktop - 97

UAT

In addition, remote user acceptance testing was conducted with 3 users; two using mobile devices and one using a desktop. Users reported a satisfactory experience, with no difficulty using or understanding the website. One user reported a typo.


Validator Testing

During initial testing, opportunity to refactor the code were discovered and an attempt was made to improve it. This resulted in larger changes than expected, such as the move to using styled sections over individually targeted elements, which required additional fixes and further testing before release.


HTML

In the first round of html validator testing, button tags and section/article tags were found to be used incorrectly. In addition, there were a small number of open and unnecessary tags that needed to be addressed.

The second round, conducted after implementing the new structure, found an open div on the index page, sections incorrectly used in place of divs and some stray tags. In two instances, changing the section to div required updating the css file to maintain syles.

The third and final round of testing before deployment returned no errors for this project.


CSS

In the first round of css validator testing, some unclosed attributes were found. This highlighted that these attributes were unecessary to the output of the code and were removed.

The second round, conducted after implementing more efficient css, found two parse errors. In addition, it warned of the use of the deprecated property 'clip'.

The third and final round of testing before deployment returned no errors for this project.


Unfixed Bugs

This release includes some bugs that should be addressed in future releases. Although appear to block using the site, they negatively effect user experience due to positioning and inconsistent styling, and should be prioritised.

  • Some divs and/or sections are not extending the height of their content on screens below 768px
  • The hamburger menu icon on mobile screens should float right
  • The mobile menu drawer should be wider and float to right
  • On very small screens (below 368px) the logo breaks onto two lines
  • Buttons are not full width on screens below 768px, resulting in some breaking onto two lines on very small screens
  • Hero and about-breeds images are not using a responsive solution
  • On Firefox and Safari the custom success page redirect brings users to the Code Institute 'form dump' confirmation page
  • On Chrome, Opera and Samsung mobile apps, the Code Institute 'form dump' confirmation page opens in a new tab or pop up while redirecting to the success page on the original tab
  • On Firefox and Safari, custom input styling is overwritten by browser defaults.
  • On Samsung mobile app, dark mode alters colors from brand

Deployment

As part of the Code Institute submission process, this site was deployed to GitHub pages. The steps to deploy are as follows:

  1. Open github.com and log in to user account
  2. Find Two-Dogs repository
  3. In the GitHub repository, navigate to the Settings tab
  4. Find the page section on the left hand menu
  5. Check source is 'Deploy from branch'
  6. Check branch is 'main'
  7. Click save
The first deployment highlighted incorrect filepaths across the site, breaking css and navigation and images. When the paths were corrected the site was retested across multiple browsers and devices (several redeployments were required). On final validation an error was returned for success.html regarding incorrectly used mute tags and a deprecated border tag. Once the site as retested and validated, this readme file was updated and a final deployment was executed.


The live site can be found here - https://somekindofdesign/two-dog.github.io/two-dogs/index.html


Credits

Code

The code from this project was implemented by the project owner, Louise Stanley. Additional help, guidance and solutions were also used from the below sources.


Code Institute - Love Running Walkthrough Project

W3Schools

Slider Revolution

Medium


Content

Although the content is unique, the project including layout, features and readme file were guided by the Code Institute Portfolio 1 Assessment Guide.

All written content was provided by the project owner, Louise Stanley.


Media

Images and videos were generated by Louise Stanley with the exception of the background image for the About Breeds section. Please see content creator information below.


two-dogs's People

Contributors

somekindofdesign 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.