Giter VIP home page Giter VIP logo

videogamereviews's Introduction

Royal Robot Reviews

This website has been created for users to write reviews for a selection of games and compare their scores.

The live site can be found here

Responsive Mockup of site

Table of Contents

User Experience

User stories

As a user I would like to be able to...

  • View the list of Video Games so that I can select one to review
  • View a paginated list of videogames so that I can easily select a videogame to view
  • Click on a game so that I can read the full details and reviews of the game and I can review it
  • View a list of reviews so that I can select one to read
  • Register an account so that I can review, comment, and like
  • Leave a review for a game so that my opinion is heard and I can be involved in rating the game
  • Edit or delete my review in order to show my change of opinion or remove mistakes

Admin Stories

As an admin I would like to be able to...

  • Create draft games so that I can finish writing the content later
  • Create, read, update and delete games so that I can manage the site content
  • Create, read, update and delete reviews so that I can manage the site content
  • Approve or disapprove reviews so that I can filter out objectionable content

Planning

  • Colour Scheme

    • Simple black and yellow colours for most of site and purple for logo to represent royalty
    • contrsating colours for easy legiblity and style

    Colour scheme #000000 #F1B814 #490B3D

  • Font taken from Google Fonts

    Romanesco Font

  • Pages were planned out on Figma using wireframes

Features

  • Logo
    • The logo was made using Canva
    • Used as link to return to the home page
    • Logo uses purple to represent royalty

Logo

  • Base Template

    • Header with navigation bar

    Header with navigation

    • Footer with social media links

    Footer with social media links

  • Index Page

    • Introduction telling you about the site and what to do

    Introduction

    • List of Games to choose
    • Games ordered by average review scores
    • Images, titles, scores and developer shown on each game card

    List of games

    • Paginated if above 6 games

    Paginate Next Button

  • Game Detail Page

    • Game detail with average review score and description

    Game image, title, reating and description

    • Game reviews with the ability for user's to edit and delete their own reviews

    Reviews of the game

    • Review Form with stars that reflect the users rating

    Review form

  • Edit Review Page

    • Will fill the inputs with the review of that instance to be edited
    • Submits an updated review to be approved again

    Edit Review Page

  • Delete Modal

    • An 'are you sure?' modal to prevent users from accidentaly deleting

    Delete Modal

  • Messages

    • Review submission, sign in and out message confirmation
    • Times out after 2.5 seconds
  • Account pages

    • Login logout and signup pages connected with allauth

Future Features

  • Users can add games
  • Add a spoiler-free tag on reviews

Testing

HTML

CSS

JavaScript

Browsers

  • Tested on Google Chrome, Internet Explorer, Microsoft Edge and even the Samsung Internet App on Mobile and Tablet

Responsiveness

  • Tested responsiveness on a Samsung A21 Phone, Samsung Galaxy Tablet and Desktop
  • Tested with Google Chrome Development tools for different screen sizes

Accessibility

  • Tested using a web accessibility evaluation tool called Wave
  • Semantic HTML is used
  • Headers are in order and not skipped (h1, h2, h3)

Bugs and Solutions

  • The starRating function would produce undefined sometimes, so an if statement was used to filter them out to avoid errors
  • The fixed bottom footer would overlap onto the main content, so using flexbox and a mininum height of 100vh for the body element fixed this instead of fixing it to the bottom
  • The game list contents overflowed out of their cards, boostrap classes was used to change the size of the cards accordingly while keeping them all the same height
  • The edit review page wouldn't fill the inputs with the rewview data, so redefining the review instance tended to fix this

Languages and Programs Used

Languages

  • HTML5 for site structure
  • CSS3 for styling
  • JavaScript for star ratings and message timeouts
  • Python 3.0 for Django

Libraries and Frameworks

  • Django's model view template structure was used to create apps and run them
  • Boostrap4 framework used for responsive styling and templates

Development tools

  • Git for version control
  • VS Code as IDE (integrated development environment)
  • PIP to install packages
  • Postgresql for the database to create content and manage data
  • Heroku used for deployment

Required modules

All modules required are located in the requirements.txt file.

Credits

videogamereviews's People

Contributors

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