Giter VIP home page Giter VIP logo

cobrakai's Introduction

Cobra Kai

image of cobra kai

This project was designed to allow younger age groups to learn more about karate and hopefully sign up to lessons. This website will allow users to read about karate, Cobra Kai in particular, look at the gallery, see timetables for lessons and to sign up for classes if they wish. As the developer I designed this project after watching the new Netflix TV series, Cobra Kai. I would like for younger kids to have a platform to learn more about Cobra Kai, view photos and hopefully come to learn!

Contents

  • UX (User experience)
    • User Goals
    • User Requirements and Expectations
  • Wireframes
  • Features
    • Features that have been developed
    • Features that will be implemented in the future
  • Technologies Used
  • Bugs discovered
  • Testing
  • Deployment
  • Credits
  • Awknowledgements

Development

To get set up for developing :

  1. Clone the repository git clone https://github.com/ShannonD7833/CobraKai.git
  2. Change into project directory cd CobraKai
  3. Run the server
    • VS code
      • Install live server extension
      • Go to "View > Command Palette" and type "Live server" and select "Open with live server"
    • Python HTTP server
      • Python 2 python -m SimpleHTTPServer 5500
      • Python 3 python3 -m http.server 5500
  4. Open http://localhost:5500

UX

The target audience for this project is aimed at teenagers. It will also include parents of these children who wish to sign up for karate.

As a new customer:

  1. I want to read information on the type of karate learnt as this company
  2. I want to see photographs to give me an idea of what to expect within the premises
  3. I want to be able to see a timetable with classes and times.
  4. I want a form which is easy to use where i can sign up for lessons
  5. I want to be able to return to the homepage quickly and easily
  6. I need to have a contact telephone number and address
  7. I want to visit the social media pages for various different platforms

As a returning customer I want:

  1. To see the times and dates of upcoming classes
  2. Updated photographs from recent classes and competitions
  3. To have a contact telephone number

As a parent of customers I need:

  1. To know the instructors are qualified and trustworthy
  2. The premises are safe to carry out karate classes
  3. To see the timetable of my childrens classes
  4. To have an address and contact number

As a developer I want:

  1. Customers to be able to navigate through the website easily and quickly
  2. Customers to feel comfortable enough to signup to karate after visiting the website
  3. Consistency throughout all pages
  4. A collage of photos in a gallery which encourage customers to sign up
  5. A Navigation bar which will be simple for customers to follow and become responsive depending on the device its being viewed on.

This project will provide all users with 4 pages including a home page packed with information, a gallery page, timetable and a signup form.

Wireframes

I used Balsamiq for my project wireframes.

Below is a link to my wireframes for all three pages of my website.

Wireframes can be viewed here.

When building my web page I did make some changes which now differ to my wireframes. Using dev tools showed me better ways to present my project and so the final project may be different to the original wireframes designed. I was not going to use bootstrap initially but then became confident in using it so the layout of a few things changed in my final project from my wireframes.

My final design was slightly altered due to various factors but I am happier with the outcome. Responsive

Features

  • Logo of the company which when clicked will return the user to the homepage
  • User will always know which page they are on since it will be underlined in the navigation bar
  • Navigation bar which when hovered over will underline each page
  • Social media icons which when clicked will take the user to a new page and open up the social media page
  • Consistent header and footers along each page of the webpage
  • Photos and descriptions of instructors and current champion
  • Interactive map with address and contact telephone number
  • Gallery images
  • Form with clear instructions on how to sign up
  • Timetable which has times of classes

Features left to implement

  • I would like to add videos in the future

Technologies Used

  • I used HTML5 and CSS languages for writing the code in this project.

  • Google Fonts was used to style the font within my project. Lato font was used for the text.

  • Font awesome icons were used to add icons to the social media links in the footer.

  • Google maps was used for the iframe for the address map.

  • Bootstrap was used to make my website more responsive using layouts and tables to assist with my styling.

Bugs Discovered

  • Index.html

    • Images were square so I changed this to make it more visually appealing using chrome dev tools. Without border radius and then I added a border radius of 50% which can be seen here.

    • The margin between the social media links were too close together so using dev tools I played around with the padding size and found one that worked here.

    • I used bootstrap to align my images in a much more user friendly way. I then checked this using dev tools to ensure the design was consistent at my breakpoints which worked out much better here.

  • Signup.html

    • My submit button would not align into the center. I used dev tools to see if I could align it but I then had to align my parent DIV centrally and the button afterwards aligned.

    • Table layout from bootstrap did not work correctly when then scaled down to my mobile breakpoint. I changed the layout of the timetable so it was more visually appealing and especially when viewed on mobile devices.

    • The table before changes were made. Updated table is easier to view on mobile devices.

    • My navbar did not work across a few breakpoints so I added a Bootstrap navbar to ensure at each breakpoint the navbar is responsive. The new navbar can be seen here where it becomes a dropdown navbar which is much more user friendly for smaller devices.

    • General bugs throughout my pages were layout issues on different devices and I fixed these by using margins and paddings which can be seen in my CSS.

    • When viewing my website on my own mobile, layout on the index.html page did not look right, there was padding around the second paragraph tag. I took this out to make the page more consistent on small devices here.

    • Instructor paragraphs viewed on my mobile looked too big, I changed the font size and it worked much better from 20px to 13px here.

Testing

  • I tested my media queries and responsive design using the dev tools on chrome, as you can see the tablet view here for the index page, gallery page here, signup page here and finally the classes page here.

  • The same testing was done using the mobile view for the index, gallery, signup and the classes.

  • I tested my media queries for the mobile view using dev tools which can be seen here

  • I had to make sure the navigation bar links were interactive and when clicked brought me to a different page and this can be shown here. The link under the navigation link became underlined and when clicked brought me to a the gallery page.

  • When testing the social media icons, I clicked on them and they opened up the corresponding social media platform on a new page which is what I expected to happen so I knew that they worked.

  • I tested my HTML using the validator and initially there was an issue with a child element. This was fixed as I had put the li and ul element in the wrong way and when this was fixed the issue was resolved. The HTML passed the validator. I tested each page of my website in the HTML validator. The gallery , signup , timetable can be seen.

  • My CSS passed all the tests using the Jigsaw validator.

Testing UX

I have checked off each of my user stories to ensure I have made my website suitable for all users needs and wants.

As a new customer:

  1. I want to read information on the type of karate learnt as this company
  2. I want to see photographs to give me an idea of what to expect within the premises
  3. I want to be able to see a timetable with classes and times.
  4. I want a form which is easy to use where i can sign up for lessons
  5. I want to be able to return to the homepage quickly and easily
  6. I need to have a contact telephone number and address
  7. I want to visit the social media pages for various different platforms

As a returning customer I want:

  1. To see the times and dates of upcoming classes
  2. Updated photographs from recent classes and competitions
  3. To have a contact telephone number

As a parent of customers I need:

  1. To know the instructors are qualified and trustworthy
  2. The premises are safe to carry out karate classes
  3. To see the timetable of my childrens classes
  4. To have an address and contact number

I am happy that I have met all the wants and needs of different users who will avail of my webpage. I have also met my own goals as a developer.

Deployment

GitHub Pages

Pushing a new commit to the master branch triggers a new deployment to github pages.

Website available on https://shannond7833.github.io/CobraKai/

Set up deployment to Github pages

  1. Log in to GitHub and locate the Repository
  2. At the top of the Repository (not top of page), locate the "Settings" Button on the menu.
  3. Scroll down the Settings page until you locate the "GitHub Pages" Section.
  4. Under "Source", click the dropdown called "None", choose the Branch master and choose /(root) as the folder to serve the static website from.
  5. The page will automatically refresh.
  6. Scroll back down through the page to locate the now published site link in the "GitHub Pages" section.

Credits

Credit for text used on this website

Credit for images used

Acknowledgement

  • I received inspiration for this project from the TV series, Cobra Kai on Netflix.

  • Special thanks to Christopher Temple for his support and knowledge and the tutors at Code Institute for helping me with issues!

cobrakai's People

Contributors

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