Giter VIP home page Giter VIP logo

best-compressed's Introduction

Best Compressed

The Best Compressed website is a public information website that provides advice and user-led suggestions for those who use compression garments. Its aim is to present the information about the various types of compression garments available and to clear up some of the confusion about the purpose of one type over another.

The live site can be accessed through this link.

Ui.dev Responsiveness screenshot

Contents

User Experience UX

The ideal user of this site will be:

  • over 16 years old.
  • a novice wearer of the garments used in compression therapy.

Back to Contents

User Stories

  • As a user, I can find the information I seek quickly.
  • As a user, I can understand the information as it is presented to me.
  • As a user, I can clearly make out the links to each page.
  • As a user, I can understand the information in the videos.
  • As a user, I can leave a message through a provided portal.

Back to Contents

Wireframes

The wireframes for this site were produced and are hosted on the site Balsamiq. Please click this link to view them and the planning notes.

Back to Contents

Site Structure

The style of this site will be simple and uncomplicated due in consideration of the large age scope and possible divides in user prowess with internet technology. Any possible and futher design works will take the computer user generational divide into consideration.

It consists of 3 formatted pages consisting of a hero image, a main description section and 3 subsequent column sections and 2 additional pages, one with a form box for the collection of data in the aim of creating the database of personal advice from experience compression wearers and another with a thank you message to acknowledge the sent data.

Back to Contents

Design Choices

Typography

The fonts chosen for this project were 'Kavoon' for the headings (h1, h2 etc) and 'ABeeZee' for the body text.

  • Kavoon is considered a Comic/Cartoon style which has a heavy font weight as normal and that appears to be somewhat condensed in the manner of the letter forms. It was chosen to play on the topic of the site until a more formal logo can be designed.
  • ABeeZee is, according to its design Anja Meiners, "a children's learning font. Open, friendly and simple, the definite shapes support the process of learning to read and write." It maintains a clean distinction in letter form as the screen sizes adjust.

Fontjoy pairing tool

Back to Contents

Colour Scheme

The choices for the colour scheme were based on examination of other like purpose sites. The use of primary colours, particularly red was prominent in most of the sites that dealt with medical advice or patient advocacy. I was cautious about using any colours that are strongly associated with one medical condition over another in order to preserve an inclusive environment for any user - this site is not for a specific condition, just for a specific health aid.

Colormind Colour Chart

To alter in some way from the norm but still maintain an air of familiarity, I chose variations of red and blue to accent the text elements. These colour choices were also checked using Adobe's Color Wheel webpage for suitability for those who suffer with colour blindness.

Adobe Color Blindness Accessibility Test

Back to Contents

FEATURES

Existing Features

Home

Navigation Bar

logo

  • Situated at the top of the page, the page logo 'BEST COMPRESSED' is shown on the left hand side with the page menu located on the right, listing this HOME page as well as 3 addional pages. Each page is assigned an icon as a visual aid and will have an 'active' line beneath each link as its appropriate page is visited.

wide nav bar

  • Once the site adapts for smaller screen sizes, the page logo will relocate to the center of screen with the menu options underneath it. Due to the length of some of the link names, the icons will be used instead of text when the site adapts.

mobile nav bar

Back to Contents

Introduction

  • This is a general introduction to the ethos of the site and its aims going forward. There is also a content disclaimer which reminds the user that the information here is a general guide and that the best advice comes from those trained and who have full knowledge of their individual situation. A repetition of this will appear in the footer of each page.

hero section

Back to Contents

Sub-sections

  • The 3 columns of this section each contain a seperate image, a brief explanation of the topic matter and a link to the related page within the title of the subsection.

3 Column section from Wear and Care Page

Back to Contents

Footer

  • Fixed at the bottom of the screen, the footer contains the constant Disclaimer relating to the content of the site on the left hand side.
  • There are also 3 links to relatable social media for the site's content. These three platforms were chosen for their generally understood UI which will aid the cross generational divide.
  • There is a 'Date Updated' information line to reflect the current nature of the information provided.
  • This will be present on all pages and screen sizes.

Back to Contents

What is a Compression Garment page

  • Inheriting the layout of the Landing Page, the information presented here explains simply the purposes of a Compression Garment.
  • The 3 column section uses images to catagorise the 3 main types and provides bulletpoints of the main differences of each type.
  • The disclaimer for the intent of the site can be seen in the footer along with the social media icons.

Back to Contents

Wear and Care page

  • Inheriting the layout of the Landing Page, the information in this section will be presented in 3 columns.
  • The first column will contain an image and bullet points containing short 'daily' tips for wear and care of your garments and skin.
  • Two of these columns will host externally sourced videos, one video on washing and upkeep of compression garments and another on the protection of the skin layer.
  • Each video will load with controls and muted for optimal user experience. Each video will also have as an addition, the disclaimer as posted by the original content creator.
  • The disclaimer for the intent of the site can be seen in the footer along with the social media icons.

Back to Contents

Tried and Tested page

  • The current format of this page similar in header and footer layout of its siblings.
  • One section on this page consists of a form box with name, email address and text box fields for contributing to the advice element of the site.
  • The fields are all required once data has been entered into them or the submit button is turned on.
  • The submit button has been styled to react to any pointer hovers and when it is clicked.
  • The second section gives insight into the information desired in the text box field and also provides 3 external links to websites that specialise in medical conditions or situations that require the use of compression garments.
  • The disclaimer for the intent of the site can be seen in the footer along with the social media icons.

Advice Form Page

Back to Contents

Tried and Tested Thank You Page

  • Once the form has been filled and the submit button actived, the action will bring you to this page with a brief thank you message and reiteration of the promise of an advice page.

thank you page

  • There are no 'active' markers on the navigation bar by design.
  • The call to action button in the middle of the page with return you to the homepage within the current open browser window. The disclaimer for the intent of the site as well as the social media icons, can be seen in the footer.

Back to Contents

Features Left to Implement

This site was initially conceived as a public information resource with an option for adaptation depending on user feedback. Some of the features that are intended for the future without feedback are as follows:

  • Official Logo for use on site and as a watermark for other associated media.
  • Advice board where collected tips will be displayed.
  • Animation/Pop-up of disclaimer, ensuring that the information reaches the user.
  • Self produced media content: videos and photos to replace all externally sourced content.
  • A possible link page to reputable sellers of accessories once self produced content is in place as current image licencing agreement makes this a conflict.

Back to Contents

Technologies Used

In the creation of this project I have used the following:

  • Balsamiq to create the wireframes.
  • HTML5 to provide the content and structure for the website.
  • CSS to provide the styling.
  • Github to host and edit the website.
  • Gitpod to deploy the website.
  • Adobe color website to confirm assessibility of colours used.
  • Codegena to create a video embedding code generator.

Back to Contents

Testing

In the building of the site, the major issues I had to deal with involved the following :

  • Weak Design Elements

    • When I first designed the layout, I wanted to keep it clean and simplistic so that it didn't overwhelm the sensibilities of any of the users. However, the combination of 'Dela Gothic One' and 'Lora' proved to be less impactful that I thought. At the beginning of the testing phase, I was advised to rethink this approach and so the fonts "Kavoon" and "ABeeZee" were chosen to replace the original choices.
  • Menu layout and presentation on smaller viewports

    • Due to the length of the text links, I added icons to the links that would become the navigation icons when the site is viewed on a smaller screen. This was done by adding classes to target the text and icons seperately so they could be hidden or seen as needed. Attention was required for both margin and padding settings for the various size screens but the presentation is equal across the different screen sizes.
  • 'Return to Homepage' button with link to homepage

    • The main issue that I encountered with this button was the fact that I expected it to react as the Submit button did on the Tried and Tested page. After many attempts to rectify the possible link issue, I realised that I needed to treat the button layout like an imported image or icon. I used the button element and its attributes as an additional attribute of the a element that actively opens the homepage in the same browser window.
  • Video Embedding

    • When I first attempted to insert a link for the youtube videos that I had selected, I was immediately shown an error message for where the video should appear. My first source of assistance was the Slack channels of CI where I searched for "embed youtube link into html". One member suggested the video embed generator created by Codegena but warned of issues may occur in validation later. I decided to use the generator for the moment as they work for MVP, I have not come across any major issues as of yet but I am aware that this may be an issue in the future.

Back to Contents

Validator Testing

HTML with W3C validator

- index.html

First issue that was highlighted on all the pages was the labeling error that was within the navigation bar. 

Error Code 1 and 2

This was created in 2 parts: the first through a spelling error which was easily corrected and the second by removing an alt property tag that had been included on part of the homepage navigation icon.

- what_is.html

There was a loose div end as the only error for the HTML Validator. This was corrected promptly.

what_isChecker

- wear_care.html

This section had the most errors from all the HTML validator reports.
Most of these seemed to be spelling errors rather than syntax. These were all corrected.

Corrected

- tried_tested.html     

The majority of the errors highlighted were corrected but there were 2 that are still unresolved.
The submit button link created an error in this validator that I have not fully corrected. The link is still working and so I will continue to monitor the status of this error.
The validator also highlighted what appeared to be a random end p tag but when the lines of code were explored, there didn't seem to be any open tags. Again, this will checked again.

Phantom p

- tried_tested_ty_html

Errors

The article error was quickly resolved but the button error failed to return a viable correction. As the function required from the button is working and I found no other acceptable solution for the validator, I have chosen to leave it as it is for the present.

CSS with (Jigsaw) validator

W3C CSS Validator Results

While the W3C Validator has given this site the pass result, I am aware there are still some conflicts within the syntax. The result of this is seen more clearly below.

Lighthouse Validator

The following images show the results from the Lighthouse Developer Tool based on desktop and mobile standards respectively.

Lighthouse Desktop 1260 Result

Measuring the criteria of Performance, Accessibility, Best Practice and SEO, the results have varied depending on the screensize that the site was assessed through. Part of the issues highlighted include the lack of defined dimensions for the images within the site. Due to the aforementioned issues with column formatting, some of the original measurements have been removed in an attempt to rectify the issue. 

Lighthouse Mobile 320 Result

Testing User Stories

  1. As a user, I can find the information I seek quickly.

    • The index/landing page has clear labels for the different sections and a descriptive text to assist in guidance.
    • The font is crisp and easy to read.
  2. As a user, I can understand the information as it is presented to me.

    • The information is written in an informal but polite language.
    • The definition of catagories is clearly marked.
  3. As a user, I can clearly make out the links to each page.

    • The links in the navigation bar are both text and icon for the desktop sites.
    • The icons have been chosen to be intuitive in their meaning.
    • The alt text has been clearly labelled for the screenreader.
  4. As a user, I can understand the information in the videos.

    • Each video is clear in visuals and audio.
    • Each video presents the information in a clear but precise manner.
    • Each video narrator speaks in a clear voice and uses a common vernacular.
  5. As a user, I can leave a message through a provided portal.

    • The form provided allows for the creation of a message.
    • The links to the social media sites also facilitate the possibility of communication.

Back to Contents

Unfixed Bugs

  • Column layout and sizing images to screen sizes.

    • This is an area that I am still endeavouring to conquer. My aim of having a responsive website across 3 if not 4 different screen sizes centered around a 2 section construct within the main body of the page. The top section allowed for 2 seperate column areas that could be utilised for images, text or forms. This was done will little difficulty. However, the lower section proved to be somewhat elusive for me - I was not successful in my time constraint to find the correct syntax to generate the correct behaviour. This is something that I can correct but at present, I am required to stop my search for answers in order to ensure with the rest of the site's functionalilty.
  • Form Format

    • The coding for a basic form layout was readily available in various locations so I implemented the form values from the w3school website to create my version. While I have found it to be easily responsive to the smaller screen sizes, I have not been able to successfully identify the syntax I need to evenly space the form element beside the additional text on the same page.

Screengrab of form layout on large screen

Back to Contents

Deployment

The site was deployed to Github pages using these steps:

  1. Open the relevent repository in my Github account.
  2. Navigate to the Github Pages tab via 'Settings'.
  3. Select 'Main' from the drop down menu in the Source section.
  4. Click 'Save' once you have confirmed that the branch is listed as Main and that the folder selected is the root folder.

The live link can be found here -Best Compressed

To clone this Github repository, please follow these steps:

  1. Open the target repository and click on the Code button located beside the Gitpod button.
  2. From the drop down menu, select your preferred format (HTTPS/SSH/Github CLI)
  3. Once selected, click on the double box symbol beside the address bar to copy your choice's URL
  4. Open Git Bash.
  5. Change the current working directory to the location where you want the cloned directory.
  6. Type the words 'git clone' into the terminal window, and then paste the copied URL.
  7. Press 'Enter' to complete the process and open the cloned repository.

Back to Contents

Credits

Content

Adobe Color Website for assistance in creating a suitable color palete that was both pleasing to look at but assessible to those who are colorblind.

Solution to icon-text replacement issue

MDN Web Docs for coding syntax assistance.

CI Slack Channels for solution sourcing and general problem solving.

StackOverflow for solutions and general problem solving.

CSS-Tricks for assistance on footer issue.

W3 for aid in creating responsive form element.

Back to Contents

Media

All images are supplied under licence from Shutterstock from the following content creators: Petia_is, Jacob Lund, Andrey_Popov, Nikolas Gregor, Bokehboo Studios and Yuliya Yesina.

The video How to Care for Compression Socks video was sourced from YouTube.com, created by The Sunny Edge.

The video Eczema, Dry Skin, and How to Treat was sourced from Youtube.com, created by Doctorpedia

The Video Plugin Code was generated by Codegena.com

Back to Contents

Acknowledgements

Many thanks to my mentor Precious Ijege for his patience and guidance, to Joanana Skoczen, Emanuel Silva and Robert Kennedy for helping me see the coding trees in the script forest and to Kenan Wright at CI for all his assistance.

Back to Contents

best-compressed's People

Contributors

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