Welcome to TypeKwondo!
As all developers will tell you, being able to type quickly and accurately is an invaluable skill. Not staring at your index fingers whilst trying to work out where the missing semi-colon is actually really useful!
And what else do developers love? Gamification! Introducing TypeKwondo, where you get to improve your typing skills, whilst competitively playing a typing game in a theme of your choosing. On top of this, you can also compare your scores with the leaderboard and try and make it into the top 5 best typers ever (*not an official title)
You can visit the live website here
- TypeKwondo!
- Contents
- UX
- Features
- Create a user-friendly program.
- Create a game that is straight forward to start, play and restart.
- Create a game that has additional benefits to the user.
- Ensure that questions are randomised and not repeated
- Provide the user with feedback on their progress through the program and through the game.
- Catch all incorrect inputs that may break the program
- Give the user a choice of difficulty setting
- Give the user a choice of questions
- Create a database for the storage of user scores
- Provide the user with their score as well as the top 5 scores of all users.
- As a user visiting the site for the first time, I want to be able to navigate the program intuitively.
- As a user visiting the site for the first time, I want to be able to play the game quickly and easily.
- As a user, I want to be provided with feedback such as correct answers.
- As a user, I want to be able to choose a theme of questions.
- As a user, I want to be able to set the difficulty of the quiz
- As a user, I want the questions to be randomised to keep the game interesting.
- As a user, I do not want to break the program by putting in unexpected inputs.
The target audience of this website is any person who :
- enjoys games
- want to improve their typing ability
The program is designed to be quick and easy to play:
- Welcome page - This contains a ASCII art title and the menu options.
- How to play page - This provides details on how to play the game
- Leaderboard page - This provides the a leaderboard of the top 5 highscores
- Options pages - The user is given the choice of difficulty and question theme
- Game page - The user is shown a word to type. The score and lives are shown after each question
The initial ideas were taken from the structure planning and a process tree was created using app.diagram.net
.
- Contains ASCII art title of the game
- Gives the user 4 options;
- To start a new game
- View leaderboard
- How to play
- Exit game
- If you do not enter one of the corresponding numbers, you will be told what you have entered and asked to enter the number of one of the options provided
- Prettytable library has been imported and used for the structure of the table.
- The leaderboard consists of three columns; User, Score and Difficulty.
- The data from the leaderboard is pulled from the googlesheets database.
- You are also provided with the menu options.
- How to play explains the different elements of the game as well as the scoring structure
- The menu options are also provided for continuation
- You are asked to enter your name
- You are then asked if this is correct
- If you do not answer yes or no to whether it is correct, you are redirected to answer the question again. You are told what you have entered.
- Once you select your name, the console prints out Hi and your name
- The quiz provides 5 different quiz types: Star Wars, Harry Potter and Periodic table of elements, popular cheeses and populous countries.
- You are asked to choose which you would like to play.
- The difficulty setting is next requested. You can choose easy, normal or hard. Easy applies a 1* score multiplier, normal is 1.5* and hard is 2*. Additionally if you play on normal you have 3 lives, normal you have 2 and hard you have 1.
- Incorrect input is captured and directed back to the user
- The number of correctly answered questions and lives are shown at the top of the quiz.
- The word to type is shown underneath
- The terminal is cleared after each question
- After the quiz ends, you are shown your score
- A menu is provided at the end of the quiz for continuation
Data is sent from the app to the database (spreadsheets). The following table was created to show the data structure through the app
| Title | Key in Database | Data Type |
|---|---|---|
| Name | name | CharField |
| Score | score | DecimalField |
| Difficulty | difficulty | CharField |
There are two sheets associated with the app. The first acts as a dump for all the data from the games that have been played. The second is generated from the first and is ordered numerically allowing the top 5 to be taken. This is achieved using "=sort(Sheet1!A:C, 2, FALSE)" on the second spreadsheet.
- Add additional question sets
- Add a superhard difficulty setting that is case sensitive
- Add a variant where the word you have to spell is hidden after a second.
- Python
- Programming language providing content and logic of project
-
- IDE (Integrated Development Environment), for writing, editing and saving code.
-
- Remote code repository.
-
- Cloud application platform used to host program
-
- Used to create process diagram.
-
- Used to create the title on the homepage
-
Python Libraries:
- os - Used to clear the terminal
- time - Used for creating a timer
- random - Used to randomise questions
- prettytable - Used for the leaderboard
- string - Used for capitalizing input to match that of the database
- gspread and google.oauth2.service_account for linking google sheets
7.http://pep8online.com/ - PEP8 Validator used to check code for compliance
The testing process can be seen in the TESTING.md document.
The site is hosted using Heroku, deployed directly from the master branch of GitHub. The deployed site will update automatically as new commits are pushed to the master branch.
To host on Heroku you must follow these steps:
- Create a requirements.txt file in the home directory of project
- In the terminal write : pip3 freeze > requirements.txt
- Go to Heroku
- Login to my account.
- On the Heroku dashboard click on 'New'
- Click on 'Create new app"
- Input the app name
- Select region
- Click "Create app"
- Reload the page. Scroll back to 'GitHub Pages' section, where the new URL for the deployed site can be found.
- Click on "Reveal Config Vars"
- In the field for key, enter "CREDS"
- Copy contents of creds.json into the corresponding value field.
- In the next field for key, enter "PORT"
- In the corresponding value field enter "8000"
- Click "Add buildpack"
- Click "Python" and then "save changes"
- Click "Add buildpack"
- Click "nodejs" and then "save changes".
- Ensure these build packs are listed in the order above.
- Click on Github under deployment method
- Search for repository and then click on "connect"
- Click on "Enable Automatic Deploys"
- Login to GitHub.
- Locate your desired repository.
- Locate the fork option in the top-right hand corner of the repository page.
- You will be asked where you want to fork it to.
- Code lines 20 - 31 in run.py regarding connecting googlesheets APIs adapted from Code Institute LMS
- Clear screen function code adapted from stackoverflow here
- to tutor support at Code Institute. I have constantly found their positivity and genuine interest in helping resolve issues in my code a great help
- to my mentor, Richard Wells, who reviewed my project and gave feedback.
- to my partner who is always willing to test everything I create