The Project is deployed here
GitHub repository is here

The Family Quiz is a web application of ten questions quiz game built on a Python terminal that runs in the Code Institute terminal on Heroku. The project was designed for the purpose of completing the Portfolio 3 Project for a Diploma in Software Development(E-commerce Applications)with the Code Institute.

• I want to be able to open the quiz program
• I want to be able to check the rules of the Quiz
• I want to be able to skip the rules of the Quiz
• Once I pass the quiz rule I want to be able to start the Quiz.
• I want to be able to see my score during the Quiz.
• I want to be able to see my final score at the end of the Quiz.

• First time visitor is given the option to see or skip the quiz rules.
• First-time visitors can play the Quiz.
• Once start the Quiz the user can keep track of the score.
• After the quiz is completed the user can check his score on the terminal

• I would like to play again the quiz.

The flow chart showing the logic of the program can be found here:

The program is a command line program that leads the user through a series of questions and statements from start to end.

• The program starts with a welcome message and asks them to choose if want to see the quiz rules
• The user has the option to see the rules by typing 'yes' or to start the game by typing 'no'
• If the user type other than the words 'yes' or 'no' will get a message with an Invalid answer
• When the user starts the quiz he will be asked the answer to each question by typing True/False
• After each question, the user can see if the answer is correct, and his score
• If the user is typing anything else than letters True/False will get a message of Invalid answer
• When the user answered all the quiz questions he will get a message of Congratulation and his final score

• Used Object Oriented progarmming to create class Quiz as init , and class QuizBrain for the actions take on quiz all called on run.py.

• TITLE FamilyQuiz - gives a nice introduction to the quiz, and suggests the topic of the quiz. Pyfiglet library was called to display the Title. From pyfiglet imported figlet_format method to convert ASCII text into ASCII art fonts. Chosen font for the title was 'slant'.

• IMAGE - ASCII art the emoji is shown when the program starts. This gives a nice introduction to the quiz with the image of an emoji wishing good luck to the player.

• COLORAMA added a feature to allow different colors of fonts to display in the terminal. This feature aims to help the user understand what the program is doing or what is expected of the user. Since the command-line is not user-friendly, the user is not used to reading various lines to understand that there was an error returned. Once the error message is in red it stands out amongst other lines and allows the user to act on it.

Various colors are used to help the user better understand the requirements of the program:

• the ValidationErrors are displayed in red
• the positive validation messages are displayed in green
• the rules message are displayed in green
• the correct answer is displayed in yellow
• the title is displayed in yellow
• the score is displayed in blue

• Validation Various validation on user input allows the user to run the program without errors. Validation aims to capture various incorrect entries by the user and give feedback to the user. This way the user can give correct input and the program will give the user result. This also prevents the program from crashing. An example of an error validation message can be found below:

• The terminal of 80 characters wide and 24 rows high

I would like to add extra features to the program such as:

• Add a user name with age and email address
• Connect the program to a GSpread Sheet to collect all data from users like name, age, email, and score
• The final score is to be displayed together with data from a spreadsheet and to show the user score and the biggest score
• To send user results by email
• Add more quiz categories

Styling in the terminal is very limited. The interaction with the user is by Validation errors or messages informing that input has passed validation. To make the terminal messages more intuitive Colorama colors were introduced. The error messages are in red and the positive validation messages are in green. Also, the emoji image was added as a welcome screen.

• Code Institute template with HTML and CSS
• Python
• Libraries:
  • Colorama
  • Pyfiglet

The code has been put through validation PEP8 validator added to Gitpod Workspace, as the pep8online.com is currently down. The PEP8 validator was installed to gitpod with the command pip3 install pycodestyle, and you can follow the next steps to install:

• in your workspace, press Ctrl+Shift+P (or Cmd+Shift+P on Mac).

• type the word linter into the search bar that appears, and click on Python

• select Linter from the filtered results (image 1).

• select pycodestyle from the list (image 2).

• PEP8 errors will now be underlined in red, as well as listed in the PROBLEMS tab beside your terminal.

• run.py - errors to lines 51, 54, 76 "errors defaults to 'strict'", line 77 "continuation line over-indented", 107 "line to long"

• brain.py - errors line 36 "errors defaults to 'strict'", and line 43 "line too long"

• Gramarly - Used gramarly for spell check for README.md

• the questions answer was not taken in the lower case of False and True, I have fixed it with lower() and a list of[ true, false]
• indentations cause me some errors which have fixed deleting the spaces at the beginning of a code line.
• the code for the title was not displayed properly to Heroku , so I have fixed the issue by changing the code syntax.
• on deployment, the program was not fit to the window I have fixed the issue by changing the display size to 100cols with 40rows.

• no bugs remain that I am aware of.

The site was deployed to Heroku. Please follow the below steps.

I have followed one main tutorial and I work hard to understand Object Oriented Programming and adapt as much as possible to my quiz different.

• Code Institute without I would have had no base to begin a project & Readme.md Template. For this template, I have changed the size of the screen display for easy reading. https://codeinstitute.net/ie/
• GitHub for my workspace and saving all my work as well as my deployed project. https://github.com/ ;
• The Slack community - for someone always been there no matter the time and with advice or direction. https://slack.com';
• Open Trivia DB API- for quiz questions format. https://opentdb.com/api_config.php
• https://smartmortgages.ie/ - inspired me for building the site and get the content from them;
• https://www.udemy.com/course/100-days-of-code/learn/lecture/19964920#overview - Udemy course help me to develop this project;
• https://www.udemy.com/course/complete-python-bootcamp/learn/lecture/9478306?start=120#overview - Udemy course helps me to understand Object-oriented programming in python;
• https://www.w3schools.com/ - guide me with python class and method;

• emoji image - ASCII Art from https://text-symbols.com/ascii-art/#all_cats

• I'd like to thank my mentor Ronan McClelland for his guidance throughout my project.
• I would like to thank everyone for all and any assistance given during the development of my website.
• All information within this website is for education and training purposes only.
• All code has been as much as possible credited to the source that the code came from.