Giter Club home page Giter Club logo

milestone-project_2's Introduction

One More Team

This website will serve the purpose of helping football fans to be able to conveniently get relevant information on the team they support. The aim will also be to gives fans the chance to compare two teams beside one another from different leagues, and support the longer-term goal of the website to give fans one more team to support. The website will inform users about:

  • Information on any team they search for (league standing, next game, contact information, club website)
  • Compiled data on teams and their league performances overv the past 3 years
  • What team they could support, based on how their team performs vs. a foreign team with similar league performance

By looking to engage fans to support more than one team, this can help make the sport more exciting for the fan in terms of more sports content to follow. In terms of commerical opportunties, this can bring potential in drawing in new, foreign fan bases for teams and support globalization of sport. This would all be done by providing two search functions - one to check current league perormance and next game information, and the other providing a way to compare two teams based on league performance over the last 3 years.

Business goals:

  • To provide a new revenue streams for sport teams/clubs by providing a new way to obtain international fan bases
  • By providing new revenue streams for sports teams/clubs, subsequently would look to obtain revenue in the form of commission in providing potential new customers/fans
  • To build an exciting application for the developer's portfolio, this being an idea he'll want to develop further in the future

Goals of users/sports fans:

  • To conveniently and efficiently check up on relevant information on the team(s) they support
  • To give inspiration for choosing a team in another geographic region to support

UX

Ideal User

Users visiting my website would be:

  • From anyone in the world
  • A football fan
  • English speaking

Users on my website will want to:

  • Get inspiration for another team to support in a foreign league
  • Have an efficient and convenient way on updating themsleves on a given team's league performance
  • Be directed to where they can find more information on a given team(s)

Why this website is a great solution:

  • Currently in the football industry there is no clear advisor for fans who would want to add to the teams(s) they support
  • Curious fans and/or fans who live and work abroad do not have any basis/support in finding a team to follow in the new country they reside in
  • The solution can contribute towards greater globalisation of the sport, helping football teams/clubs themselves to become more international
  • More international fans can lead to new streams of commerical activity for foreign leagues and teams (through advertising game broadcasting, merchandise etc.)

User Stories

  1. As a new visitor to the website, I want it to be very clear as to what the purpose of the website is
  2. As a new visitor of the website, I want to get concise and relevant league statistics of the team(s) I follow
  3. As a new visitor of the website, I would like some inspiration for a team in a foreign league to support, either out of curiosity or because I want to localize myself in a new country
  4. As a potential customer, I want to be able to subscribe to a team(s) so I can receive automatic updates/news via email
  5. As a potential customer, I want to have more information about a team(s), where I can be easily redirected to a club/team website to find commercial offerings
  6. As a potential customer/observer, I want social media links available so I can easily access a club/team's social networking activities
  7. As a an observer, I want to be able to get in touch with the website owner and be able to access social media related to the website
  8. As a visitor of the website, I want an error free user experience, with clear communication from the website if something goes wrong

Design Choices

Overall Inspiration:

This blog post inspired a number of my style choices when creating the website/application.

Font

Sans-serif was my font of choice, as it is a font that is easy to read and allows users to focus more on the other design aspects and functionality of the website.

Icons

I used Font Awesome icons for my social media link icons in my footer - this being a visually appealing way to indicate to users how to access website-related social media pages

Colours

I drew inspiration from this blog post for my colour scheme that ended up predominately following the SCUBA theme, consisting of coral, ice blue, grey and teal. I felt this colour scheme could effectively draw the user’s focus better on the main parts of the website/application. These main aspects included the call to actions to direct users through the application journey as well as highlighting the main team match-up feature.

Hero Header section

Drawing from the main sport website inspiration blog post, videos as backgrounds were suggested and I felt this would have a positive impact on users first arriving to the website. The call to action follows the recommendation of what is common for good websites in general to ensure good UX performance. In terms of implementing the video background, I used this Youtube video for inspiration. The actual video itself I obtained as a free stock video from Pexels.com.

Information Section

Followed inspiration for design from this Youtube video. This design is for service information on a website. Since I felt that the application that’s on offer is a type of service, I felt this design could be a good way to explain the concept to users as easily as possible. Especially, since the concept is new for football fans, I felt it was very important to have a design that can clearly convey information. The bolder call to action helps direct users further on to the next section once they’re done reading. Hover animations on the information boxes helps users to focus on a particular section they’re reading.

Team Match-Up Section

I used the attention-grabbing colours of my chosen colour scheme (coral, teal) to emphasize this section and feature, to inform users that this is the main feature of the user experience to engage with. To give an easy reading experience for users, I chose a white background for the team stats and graphs once they’ve appeared. These phase into the page through a slide-down animation to give users a smooth transition from selection to results displaying. I replicated many styles from the information section, changing only the colours, in order to give the website a more consistent feel.

Wireframes

I used the tool Balsamiq in order to create my wireframe. I prodcued one png file that has wireframe images of the idea on desktop, mobile and tablet. The reason that this wireframe is vey concise is that my initial thoughts were that the design of the webpage would be more concise than how then end product of my project looks like.

Wireframe of Gustaf Ljungwaldh's Second Milestone project 'One More Team'

Features

Existing Features

1. Hero Header

  • Upon arrival to the website the user is greeted with a hero video of a camera panning around a football stadium from a sky view to give an impactful, football-related introduction. This is couple with a simple text logo with a slogan
  • Simple call to action button ‘Get Started’ to direct users to the next section

Screenshot: Hero/landing section

Differentiations from Wireframe
  • Placed Website logo test and slogan over the hero media instead
  • Used a video as the background instead of a static image
  • Made the hero header section cover full width and height of viewports
  • Placed call to action button which directs users to the next section of the website

2. Information section

  • Call to action from the Hero Header section brings the user to the About section with information about the application. This aims to inform users the purpose of the website/application, how it works, and information of features for the future
  • Tooltip is provided on the underlined test in the first information box, giving more information about traditional football fan behaviour, which could help users who are less familiar with the sport and the fan culture.
  • Slide up animation when users hover mouse over on desktop (press on smartphone/tablet) on the information boxes helps to give some user feedback and assistance in reading specific information boxes
  • Simple call to action at the bottom with the text ‘Find Your team’ again helps users to be directed to the next step without having to scroll down

Screenshot: First Information section image

Screenshot: Second Information section image

Screenshot: Third Information section image

Differentiations from Wireframe
  • This section was not drafted at all in the wireframe - added to give greater clarity to users

3. Team Match-Up section

  • Call to action from the Information section directs users to this section, where two dropdowns for selecting a league and two dropdowns for team selection are available
  • User can select a team with the default set leagues or changes the league(s) he/she wishes to generate their recommendation with.
  • Upon user selecting a league(s) and a team, the feature generates league statistics and a pie chart of games won, drawn, and lost for their chosen team as well as their recommended team based on current league position
  • When the user changes the league in one of the league dropdown menus, the previous results will clear to give a clean space so a new set of results to generate in once the user makes another team selection
  • Animations on team data slide down and sliding up provide smooth transitions
  • When a team selected does not successfully load its image from the API, a placeholder image and error message below are put in place for clear user feedback on the server/API error

Screenshot: First Team Match-Up section image

Screenshot: Second Team Match-Up section image

Screenshot: Third Team Match-Up section image

Screenshot: Fourth Team Match-Up section image

Screenshot: Fifth ITeam Match-Up section image

Screenshot: Image Error image

Differentiations from Wireframe
  • Addition of pie charts to visualize certain league statistics of the teams
  • This feature having its own section covering the full width and height in terms of viewports
  • No subscribe button and subsequent modals (reasoning for this further explained in ‘Features Left To Implement’)

4. Footer

  • Simple footer provides social media icon links to different social media platforms, where users can be redirected to relevant social media pages related to the website/application
  • An email is provided as additional information on how to get in contact with the website owner, plus information about the the developer of the website and application

Screenshot: Footer image

Differentiations from Wireframe
  • The contents of the foooter are centered from the start instead of having contact details/website information on one side and the social media links on the other side. This choice was made since the developer felt, from a design perspective, content being centered had an appealing look in all the different size formats (desktop, mbile and tablet)

5. API Error Modal

  • Since the API used in this project for football data allows only 10 calls per minute on a free account, the need for user feedback is apparent in regards to if the user makes too many selections in quick succession and/or too many users using the website
  • A simple and straightforward modal appears when this API error appears in the screen through a fade in animation, indicating to the user to please wait a minute in order to get the data requests working again

Screenshot: API Error Modal image

Differentiations from Wireframe
  • This feature was not included in the wireframe, where this scenario had not been accounted for yet at the time of drafting up the wireframe

Features Left to Implement

1. Subscribe feature

In the wireframe I set the ambition to have a Subscribe feature, where a button is present under each teams’ stats and graphs. This button would produce a modal with a form to enter the user’s email address, and once submitted, exits the modal and a quick pop up message appears thanking the user for subscribing. The user would then receive an email informing him/her which team they have subscribed to. This requires implementation of the EmailJS API, which unfortunately was not possible within the time scope of this project.

2. Access to more team statistics

In the future, users could filter their team recommendation generation based on different statistics and time periods eg. (number of goals scored over two seasons). This would also include the need for form elements such as radios and/or checkboxes to implement these filters. This would add greater complexity to the Javascript code, and due to the short time scope of the project, this wasn’t possible to implement.

3. Having more leagues to choose from

This version of the website is only using the leagues that can be provided on a free account with the chosen API. To increase the amount of leagues to choose from would require financial investment into a paying account of the API.

Technologies used

This project has included the use of HTML, CSS and Javascript programming languages.

  • JQuery - used to simplify some DOM manipulation for certain functions
  • GitPod - The developer used this tool as their IDE when building this project
  • Bootstrap - Utilized to simply html structure of website and responsiveness of it. Popper also used to be able to enable some Bootstrap functionality
  • GitHub - This project used GitHub to be able to store the project remotely and then be able to deploy the project
  • FontAwesome - Icons in the footer section for social media links coming from this resource
  • Football-data.org - API used by developer in order to retrieve football data that is displayed in the web page
  • ChartJS - Developer chose specific stats to display visually in a pie chart using this chart making API
  • ImgBB - Hosted my screenshot images through this tool so that I was able to embed them into the README.md file
    • Embedding the images files from the workspace via /assets/website-screenshots/ was not rendering the images into the README file in Github, and as a result, chose this solution to the issue

Testing

All information about the testing procedures I conducted can be found here in a separate testing.md file

Deployment

I developed this project in GitPod IDE, where I would commit to Git, and then push to GitHub via using the terminal in GitPod. I deployed this Github repository to GitHub Pages via the following process:

  • Logged into GitHub
  • Under the tab 'Repositories', I selected Milestone-Project_2
  • Subsequently I selected 'Settings' from the menu at the top of the page
  • I scrolled down the page top the GitHub Pages section
  • On the dropdown bar under 'Source', I selected 'master branch'
  • Once I selected 'master branch' the page reloaded, and the website was deployed
  • I scrolled down the page again to find the link to the deployed website within a green highlighted area of the GitHub pages section, where this section also notified me that my website is deployed

The master branch was the only branch used for this website.

How to run the project locally

To clone the project from Github:

  1. Click the following link to come to the GitHub repository for this project
  2. Click on the green button 'Clone or Download'
  3. A dropdown window will appear titled 'Clone with HTTPS' - copy the link provided in the field below
  4. Open your local IDE
  5. Change the current working directory to the location where you want the cloned directory to be made
  6. Type in git clone, followed by pasting in the url copied from Step 3 alongside the git command.
  7. Press Enter, and the clone should subsequently be created

Further troubleshooting on how to run the project locally can be found here.

Credits

Content

Media

Code

  • W3Schools providing code to help construct video tag on html, code line 35-37
  • StackOverflow code by micah5 and Raluca Albu helping with attriutes to add to video tags in order for the video to loop and work on all browser/devices, code line 35
  • Youtube video by Traversy Media I coded along to in build html and css for video background in landing section of website. Codepen reference can also be found here
  • Youtube video by Online Tutorials I coded along to for inspiration for html and css for the information and team match-up sections
  • StackOverflow code by Nick Suwyn helped with learning how to pass arguments from one javascript file to another, where in my project I wanted to pass arguments and data from index.js file to charts.js file
  • W3Schools providing css code that enables smooth scrolling when anchor tags are clicked on
  • Youtube video by Online Tutorials I coded along to parts to in order to style my select tags using html and css
  • W3Schools providing code as inspiration in building my error modal for when too many API calls were made by the user
  • StackOverflow code by xnakos providing inspiration for code i wrote that prevents graph instances from being stored on web page and stacking on top of each other after subsequent team selections. More specifically, I needed code that destroys previous graph instances before a new graph is generated
  • Youtube video by Learning Tutorial Point I gained inspiration from in building my footer with html and css
  • MDN Web Docs providing documentation on how to use template literals, which I implemented into my index.js file code line 56 to increase readability of appended string
  • Used code from Ry- on StackOverflow and from W3Schools to build a hybrid solution for my defensive programming in regards to API image urls not working. This user feedback includes a default shield image and and error text below this
  • Code lines 145 to 167 in my index.js file was thanks to ideas by Matt Rudge and Nakita McCool from Code Institute, where in the end a hybrid solution of both their suggestions was built. This logic was built to ensure users do not select the same league in both league dropdowns

Acknowledgements

  • I would like to add my sincere thanks to the tutors at Code Institute, especially Xavier and kevin (who are assigned to the full-time cohort) for their extensive support throughout the whole project
  • I would like to thank senior developers Guilherme Caminha and André Ericson at Precis Digital AB for extra guidance and coaching during the project, especially in building the team match-up logic and in debugging initial errors when building my pie charts with ChartJS
  • I would like to pass on my thanks to my class mae Louie O'Hagan for the suggestion to use template literals, as well as providing other suggestions of how to remove warnings from my JSHint validation of my javascript code
  • I would like to pass on my gratitude and thanks to my mentor Anthony Ngene for pushing me to create the best project possible, with ideas such as animations for when team stats appear, for having graphs display below team stats, and for pointing out that I would need to have clear information indicating what the website does

milestone-project_2's People

Contributors

ljungwaldh avatar

Watchers

James Cloos avatar  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.