Skip to content

This repository is for my first milestone project with Code Institute on user centric frontend development using HTML and CSS.

Notifications You must be signed in to change notification settings

kera-cudmore/Bully-Book-Club

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bully Book Club Website

The Bully Book Club website is designed to be responsive website allowing visitors to view on a range of devices. It allows visitors to find out about the book club.

Bully Book Club Website shown on a range of devices

View Bully Book Club on Github Pages

GitHub last commit GitHub contributors GitHub language count GitHub top language W3C Validation

CONTENTS


User Experience (UX)

Initial Discussion

Bully Book Club is an online book club that reviews a book once a month on Instagram. Members post a photo of the book with their bulldog with a review and use hashtags to drive up the visibility of the chosen book, author and publisher on that day.

Due to a recent growth in membership and personal commitments, the owner of bully book club is spending a large amount of time answering questions from users asking what the book club is reading and how to participate.

Key information for the site

  • What is the current months book.
  • What are the next books.
  • How to become a member and take part.
  • A way for people to contact the book club with questions and recommendations.
  • Updates on what is coming to the book club in 2022.

User Stories

Client Goals

  • To be able to view the site on a range of device sizes.
  • To make it easy for potential members to find out what the book club is and how to take part.
  • To make it clear for members to see what we are currently reading and what is coming up next.
  • To allow people to be able to contact the Book Club to ask further questions or with book recommendations etc.

First Time Visitor Goals

  • I want to find out what is Bully Book Club and how I can take part.
  • I want to be able to navigate the site easily to find information.
  • I want to be able to find their Instagram profile.

Returning Visitor Goals

  • I want to find up to date information on what the book club is reading.
  • I want to be able to easily contact the book club with questions I might have.

Frequent Visitor Goals

  • I want to be able to recommend a book for the book club to read.

Design

Colour Scheme

Bully Book Club Website Colour Palette

The website uses a palette of pastel colours that are often used in the Bully Book Club logo images. The colour palette was created using the Coolors website.

Typography

Google Fonts was used for the following fonts:

  • Merriweather is used for headings on the site. It is a serif font.

  • Raleway is used for the body text on the site. It is a sans-serif font.

  • Indie Flower is used on the thank you page for Harrison Fords message. It is a cursive font.

Imagery

The member images were used with the permission of their owners. All book covers were taken from the publishers websites. I have credited these in the credits section.

Wireframes

Wireframes were created for mobile, tablet and desktop.

Home Page Wireframe

Books Wireframe

Contact Us Wireframe

Features

The website is comprised of four pages, three of which are accessible from the navigation menu (home page, books page & contact us page). The fourth page is a thank you page which is shown once a user submits the form on the contact us page.

  • All Pages on the website have:

    • A responsive navigation bar at the top which allows the user to navigate through the site. To the left of the navigation bar is an image of book clubs logo together with the text Bully Book Club. To the right of the navigation bar are the links to the websites pages (home, books, and contact us). To allow a good user experience of the site, the Bully Book Club text is hidden with a media query on mobile devices to prevent the navigation bar looking cluttered. When viewing with mobile devices the navigation links change to a burger toggler. This was implemented to give the site a clean look and to promote a good user experience, as users are used to seeing the burger icon when on mobile devices to navigate a site.

    • A footer which contains social media icon links to instagram and goodreads. There is also an envelope icon which takes the user to the contact us page. Icons were used to keep the footer clean and because they are universally recognisable.

  • Home Page.

    • Carousel Section. The carousel shows photographs of the members of Bully Book Club.
    • About Us Section. This section is broken down into four subsections and gives users some information on the book club. On large screens the subsections are laid out in a row, however on mobile devices the subsections are stacked vertically.
    • Join Us Section. This section gives the user more information on how they can join in with the book club.
  • Books Page. The navigation link for books is a drop down menu with the following sections:

    • Currently Reading. This takes the user to the card of the book the book club is currently reading.
    • Reading Next. This takes the user to the card of the book the book club will be reading next.
    • Yearly Sections. This takes the user to the section of the year they have chosen. There are currently 3 years to select from. The books page implements a return to top icon which allows users to return to the navigation menu easily from any point as they scroll down the page.
  • Contact Us Page.

    • A List of reasons users may want to contact the book club.
    • Form The form contains fields for the users name, email address, instagram handle, checkboxes giving a reason for contact and a text area for the user to add further information. The user submits the form using the submit button. Users must fill in the name, email and text area fields to be able to submit the form. If they don't a tooltip will guide them to fill in any information they have missed.
  • Thank You Page.

    • A message thanks the user for submitting the form and lets them know someone will be in touch soon.
    • Image and message from Harrison Ford, Dictator of the Bully Bookclub.
  • Future Implementations.

    • Use javascript to perform return to top function on books page.
    • Use javascript and listeners to require at least one checkbox to be checked before submitting the form on contact us page.
    • A meet the members page - This would have a photo of the member together with a small bio. A link to their instagram and/or goodreads page.
    • Competitions/giveaways page - This page would give further information/rules on the competitions and giveaways the book club hosts.

Accessibility

I have been mindful during coding to ensure that the website is as accessible friendly as possible. I have achieved this by:

  • Using semantic HTML.
  • Using descriptive alt attributes on images on the site.
  • Providing information for screen readers where there are icons used and no text - such as the review ratings for books & footer icons.
  • Ensuring that there is a sufficient colour contrast throughout the site.
  • Ensuring menus are accessible by marking the current page as current for screen readers.

Technologies Used

Languages Used

HTML and CSS were used to create this website.

Frameworks, Libraries & Programs Used

Balsamiq - Used to create wireframes.

Git - For version control.

Github - To save and store the files for the website.

Bootstrap Version 4.6 - The framework for the website. Code for the navigation bar, carousel, cards and form were used and modified. Additional CSS styling was also implemented in style.css.

Google Fonts - To import the fonts used on the website.

Font Awesome - For the iconography on the website.

Google Dev Tools - To troubleshoot and test features, solve issues with responsiveness and styling.

Tiny PNG To compress images.

Birme To resize images and change to webp format.

Favicon.io To create favicon.

Am I Responsive? To show the website image on a range of devices.

Shields.io To add badges to the README


Deployment & Local Development

Deployment

Github Pages was used to deploy the live website. The instructions to achieve this are below:

  1. Log in (or sign up) to Github.
  2. Find the repository for this project, Bully-Book-Club.
  3. Click on the Settings link.
  4. Click on the Pages link in the left hand side navigation bar.
  5. In the Source section, choose main from the drop down select branch menu. Select Root from the drop down select folder menu.
  6. Click Save. Your live Github Pages site is now deployed at the URL shown.

Local Development

How to Fork

To fork the Bully-Book-Club repository:

  1. Log in (or sign up) to Github.
  2. Go to the repository for this project, kera-cudmore/Bully-Book-Club.
  3. Click the Fork button in the top right corner.

How to Clone

To clone the Bully-Book-Club repository:

  1. Log in (or sign up) to GitHub.
  2. Go to the repository for this project, kera-cudmore/Bully-Book-Club.
  3. Click on the code button, select whether you would like to clone with HTTPS, SSH or GitHub CLI and copy the link shown.
  4. Open the terminal in your code editor and change the current working directory to the location you want to use for the cloned directory.
  5. Type 'git clone' into the terminal and then paste the link you copied in step 3. Press enter.

Testing

Testing was ongoing throughout the entire build. I utilised Chrome developer tools while building to pinpoint and troubleshoot any issues as I went along.

The following issues were raised during my mid project meeting with my mentor:

  • The Join Us section on the home page was not in alignment with the rest of the page. Padding has now been added to bring it in alignment with the rest of the pages padding.
  • There was an issue on smaller devices where the book columns were not displaying properly. This issue is documented under issue 2 in solved bugs.
  • The introduction paragraph on the books page was not aligned in style with the rest of the page. The text has now been centered.
  • The form could be submitted with only a name filled in. ~ A required attribute has been added to the email input and textarea.

The Following items were brought up when I submitted my site to peer code review on slack.

  • Andrew Dempsey suggested to change the layout of the about us section on the index page to make it two rows instead of one, as this would improve the flow of the page on larger screens. I have moved the second two items into a second row and have added a margin bottom in the css to give the items a bit more breathing space.
  • Andrew also suggested it would look better if the contact us page inputs had a bit of room each side and were centred on the page, as they were rather long on larger screens. I have adjusted the size of the input fields and centred these on the page for a better viewing experience.

W3C Validator

The W3C validator was used to validate the HTML on all pages of the website. It was also used to validate CSS in the style.css file.

Solved Bugs

  1. The navbar would lose its alignment when on smaller devices, with the navbar brand pushing the burger icon down and over to the left underneath the site logo. This did not make for a good user experience, as the sites navigation for other sizes is on the right hand side of the navbar. While searching through the bootstrap documentation for navigation bars it directed me to display properties and hiding elements. Once I added the correct class I was then able to hide the navbar brand on devices smaller than a tablet, allowing the alignment of the navbar items to stay in place where I wanted them.

  2. The cards on the books page were very long when on smaller devices, causing the user to scroll for a while before seeing the next book. By using a media query to hide the card body I am able to condense the card for a better viewing experience on smaller devices.

  3. Halfway down the books page on small devices the columns would jump from displaying one column to displating two colums. After trying several ways to change this with no effect, I posed the problem to the slack community. Simen Daehlin suggested that I specify on the column class what sizes I would use for the screen sizes. By adding these column size classes it has resolved the problem. Column Issue

  4. The textarea required attribute wasn't activating when the form was submitted. After searching for an answer, I asked on slack and Dave Horrocks spotted that as I had a message in the textarea it was reading that as a message had been entered in the textarea. By adding the message into a placeholder the issue has been rectified.

  5. When viewing the books page which is very long, you would have to scroll all the way back up to the top to reach any navigation links. I thought a scroll to top button that floats on the bottom right would fix this problem, however I do not have any javascript knowledge currently to be able to achieve this. One alternative suggested by Dave Horrocks on slack was to change the top navbar to be fixed to the top, so this would be visable at all times. By adding the bootstrap class fixed-top I was able to achieve this. Then Dave suggested that I could use an anchor with an ID to achieve something that would work to achieve a scroll to top. He shared a codepen on slack showing how this would work I used the example of the codepen to create my return to top, and removed the fixed top class from my navigation bar to allow more space to view the books information.

  6. When I removed the fixed-top from my navbars there was a gap between the navbar and the top of the page. I added a class of navbar-top to the navbar and used CSS to positon the navbar to the top and left of the page. I added the width of 100% so the navbar would fill the width of the page.

  7. The carousel displayed fine on small screen devices, however when viewed on larger devices you would need to scroll down to see the entire image, which led to a bad user experience. By using media queries I targeted the large screen size and targeted the carousel item image to only take up 85% of the viewport height. This solved the issue by allowing the user to view the image without having to scroll, but the image was now being stretched across the screen. I searched google and stack overflow and it mentioned using object fit. I researched this further on MDN web docs and added object-fit: contain to the css which allows the image to correctly maintain its aspect ratio and view correctly.

  8. The footer was displaying at the bottom of the screen as I had used a nav tag within the footer with the class fixed bottom. As I reviewed my code for errors I realised that there was no need for a nav tag to be used within the footer. When I removed this I had to add some additional styling to the style.css file to add a background colour and some padding to the footer.

  9. When I asked for peer review on slack Anthony O'Brien pointed out that I was missing the container for the join us section on the home page. I had already added the css to style this section but had missed out putting the container class into the HTML. I have now added the container class to this section.

  10. The thank you page on small mobile devices was not displaying correctly as the image was off to one side and the navbar and footer did not reach across the page width. After struggling with this for a few days I reached out to Anthony O'Brien to see if he could point me in the right direction to solve this issue. He told me that it was simply an overflow issue and that by reducing the width of the image it would solve the issue. I have added an id to the issue and targeted the width to be 50% in the css.

Known Bugs

  1. Users are able to submit the contact us form without selecting any of the checkboxes. I would have preferred it so that at least one checkbox was selected before the form could be submitted, however when researching this problem I was unable to find a way to achieve this without the use of javascript. I asked on slack whether there was a way to achieve this, it was suggested that I could change the checkboxes to radios, however I wanted users to be able to select more than one option if they needed so this solution wouldn't work. The community confirmed that they only way they could think on to achieve this with checkboxes would be through the use of javascript and change listeners on the checkboxes. As I do not have any experience so far with javascript this is something I am currently unable to implement, but would like to add to the website in a future update.

Testing User Stories

  • First Time Visitors

    • I want to find out what is Bully Book Club and how I can take part. The about us and join us sections of the home page answer some common questions and explain how to take part.

    About us and join us section of website

    • I want to be able to navigate the site easily to find information. All site navigation is in the top navigation bar, which consistantly appears on all pages of the site. As you are able to scroll for a long time on the book page, a return to top has been added to make it easy for users to return to the navigation menu.

    navigation menu for mobile devices navigation menu for desktop return to top

    • I want to be able to find their Instagram profile.
      The instagram icon and link for Bully Book Club is presented on each page in the footer. This opens a new browser window to instagram for a good user experience.

      footer with instagram icon

  • Returning Visitors

    • I want to find up to date information on what the book club is reading. In the navigation menu there is are links to take you directly to what the book club is currently reading and what they will be reading next. The books also display a badge showing that this book is the current read and reading next.

    Books navigation drop down menu Books currently reading badge Books reading next badge

    • I want to be able to easily contact the book club with questions I might have. A contact us page provides a form that users can fill in to contact the book club with any questions they might have. The use of a text area input allows the user to ask their specific question. The footer also contains an envelope icon which users can click to go to the contact us form from any page.

    Contact us form and envelope icon in footer

  • Frequent Visitors

    • I want to be able to recommend a book for the book club to read. The contact us page allows users to select a checkbox for book recommendations. They are then able to add the books information into the text area.

    checkboxes on contact us form

Lighthouse

I used Lighthouse within the Chrome Developer Tools to allow me to test the performance, accessibility, best practices and SEO of the website.

Index Page

Initial lighthouse testing : Lighthouse Testing for Desktop Index Page - Test 1 ~ Lighthouse Testing for Mobile Index Page - Test 1

Suggestions:

  1. serve images in next-gen formats. Lighthouse suggests using image formats such as WebP & AVIF to improve compression and lead to faster downloads and less data consumption. I have now converted the logo and slide images to webp format using Birme.

Final lighthouse testing:

Final Lighthouse Testing for Desktop Index Page Final Lighthouse Testing for Mobile Index Page

Books Page

Initial lighthouse testing: Lighthouse Testing for Desktop Books Page ~ Lighthouse Testing for Mobile Books Page

Suggestions:

  1. Serve images in next-gen formats. Lighthouse suggests using image formats such as WebP & AVIF to improve compression and lead to faster downloads and less data consumption. I have converted the book cover images and logo to webp format using Birme.

  2. Properly sized images to improve load time.

Final lighthouse testing:

Final Lighthouse Testing for Desktop Books Page Final Lighthouse Testing for Mobile Books Page

Contact Us Page

Initial lighthouse testing: Lighthouse Testing for Desktop Contact Us Page ~ Lighthouse Testing for Mobile Contact Us Page

Suggestions:

  1. Serve images in next-gen formats. Lighthouse suggests using image formats such as WebP & AVIF to improve compression and lead to faster downloads and less data consumption. I have converted the logo to webp format using Birme.

  2. There is not a sufficient contrast on the small tag underneath the email input. I have targeted the text-muted class and changed the color of the text in order to improve the contrast.

Final lighthouse testing:

Final Lighthouse Testing for Desktop Contact Us Page Final Lighthouse Testing for Mobile Contact Us Page

Thank You Page

Initial lighthouse testing: Lighthouse Testing for Desktop Thank You Page ~ Lighthouse Testing for Mobile Thank You Page

Suggestions:

  1. Serve images in next-gen formats. Lighthouse suggests using image formats such as WebP & AVIF to improve compression and lead to faster downloads and less data consumption. I have converted the logo to webp format using Birme.

Final lighthouse testing:

Final Lighthouse Testing for Desktop Thank You Page Final Lighthouse Testing for Mobile Thank You Page

404 Page

Lighthouse testing:

Lighthouse Testing for Desktop 404 Error Page Lighthouse Testing for Moblie 404 Error Page

Full Testing

To fully test my website I performed the following testing using a number of browsers (google chrome, safari, mozilla firefox) and devices (Macbook Pro 14 inch, iPhone 13 pro).

I also went through each page using google chrome developer tools to ensure that they responsive on all different screen sizes.

Links.

  1. Test each link on the index page. Each link worked as expected, and any links leading to external pages opened correctly in a seperate browser tab.
  2. Test each link on the books page. Each link worked as expected, and any links leading to external pages opened correctly in a seperate browser tab.
  3. Test each link on the contact us page. Each link worked as expected, and any links leading to external pages opened correctly in a seperate browser tab.
  4. Test each link on the thank you page. Each link worked as expected, and any links leading to external pages opened correctly in a seperate browser tab.
  5. Test each link on the 404 page. Each link worked as expected, and any links leading to external pages opened correctly in a seperate tab.

Contact Us Form.

  1. Test the contact us form. I tried to submit the form without filling in any input fields. The form worked correctly and directed users to fill in the name field. I then filled in the name field and tried to submit the form. Again the form worked correctly and directed the user to fill out the email field. I filled out the name and email forms and tried to submit the form. The form worked correctly and asked the user to fill in the textarea field. I filled out the name, email and textarea field and tried to submit the form. The form then opens the thank you page in the same browser window.
  2. I tried to submit the form with only an email address - the form directs the user to fill in the name field. I filled out the name and email fields and tried to submit the form. The form then directs the user to fill out the textarea field. I filled in the name, email and textarea field and submitted the form. The form then opens the thank you page in the same browser window.
  3. I tried to submit the form with just the instagram username field filled in and the form directed me to fill in the name field. I filled in the name and instagram username fields and tried again to submit. The form asks the user to fill in the email field. I filled in the name, instagram username and email field and tried to submit. The form asks the user to fill in the textarea field. I filled out the name, instagram username, email and textarea fields and submitted the form. the form then opens the thank you page in the same browser window.
  4. I tried to submit the form with only the textarea field filled in. The form directs the user to fill in the name field. I filled in the name and textarea field and submitted the form. The form directs the user to fill in the email field. I filled in the name, email and textarea fields and submitted the form. The form then opens the thank you page in the same browser window.
  5. I selected one of the checkboxes and tried to submit the form. The form directs me to fill in the name field. I filled in the name field and the form directs the user to fill in the email field. I filled in the name and email fields and tried to submit the form. The form directs the user to fill in the textarea field. Once I filled in the name, email and textarea fields with a checkbox selected the form then opens the thank you page in the same browser window.
  6. I tried submitting the form without any information filled in. The form directs the user to fill in the name field. It then goes on to ask the user to complete the email and textarea fields if they are not filled out. The form can then be submitted and will open the thank you page in the same browser window.

Credits

Code Used

Content

Content for the website was written by the owner of Bully Book Club and Kera Cudmore.

Media

Book Cover Images

  • Each book cover was taken from the publishers website.

2022 Books

Taste

2021 Books

A Pinch of Magic ~ The Devil Wears Prada ~ A Discovery of Witches ~ The Southern Book Clubs Guide to Slaying Vampires ~ The Last Thing He Told Me ~ A Good Girls Guide to Murder ~ The Other Black Girl ~ The Thursday Murder Club ~ The Underground Railway ~ Bridgerton The Duke and I ~ The Shadow of the Wind ~ My Sister the Serial Killer ~ The Midnight Library ~

2020 Books

Nevermore ~ Good Omens ~ Starfell ~ Circe ~ Luckiest Girl Alive ~ Ballard of Songbirds & Snakes ~ The Martian ~ Queenie ~ Born a Crime ~ The Hunting Party ~ Boy at the Back of the Class ~ This is going to Hurt ~

2019 Books

Hercule Poirot Christmas ~ Crazy Rich Asians ~ Little Darlings ~

Other Images

  • Bully Book Club Logo - with permission from Yasmin Daly, Creator of Bully Book Club.

  • All images used in the carousel on the index page are photos of Bully Book Club members who kindly gave their permission for them to be used in this project.

  • Illustration of Harrison Ford used on the thank you page - with kind permission from Harrison Ford

  • Image of Milkshake the Bulldog used on the 404 page used with kind permission from Sir Meatball and Milkshake

Acknowledgments

I would like to acknowledge the following people who helped me along the way in completing my first milestone project:

  • Yasmin Daly, Creator of Bully Book Club, for allowing me to create a website based on the book club.
  • Adegbenga Adeye, my Code Institute Mentor.
  • Abi Harrison - For her webinar on meta tags, and taking the time to respond to my peer code review request in slack.
  • Simen Daehlin - For his help with the columns issue, and for taking the time to respond to my peer code review request in slack.
  • Dave Horrocks - For his help with the textarea required issue & the return to top on books page.
  • Anthony O'Brien - For pointing out my missing join us container on the index page & helping me solve the issue of the thank you page overflow.
  • Andrew Dempsey - For taking the time to respond to my peer code review request in slack.

About

This repository is for my first milestone project with Code Institute on user centric frontend development using HTML and CSS.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published