Memory
About
I developed a website for Code Institute's Interactive Frontend Development Project. The website's goal is to have gameplay of Memory game. The website is designed to be simple and easy to use on any platform or scale.
Index โ Table of Contents
User Experience
Ideal user
The ideal user for this website is:
- Anyone from 8 and above.
- Enjoys memory challenges.
- Someone who need to test memory skills.
Visitors to this website are searching for:
- Memory game.
- A way to test memory skills.
This project is the best way to help them achieve these things because:
- It is intuitive.
- Easy to understand.
- It is progressively difficult.
User stories
- As a new user, I want to be able to play the game quickly.
- As a new user, I want to challenge myself.
- As a new user, I want to test my memory skills.
Features
Start/Restart Button
Colored blue, pressing it starts the game colored grey and renamed from "Start" to "Restart. When game ends, colored blue to restart game.
Memory Game
When game starts, squares will flash green to show which squares to press. If the user selects wrong, game ends with incorrect square colored red and correct square colored green
Designs
Technologies used
- HTML5
- CSS3
- HTML Validator for validity of HTML
- CSS Validator for validity of CSS
- Bootstrap4 for the grid layout, components and styling
- Git for version control.
- GitHub for the repository to store the files.
- GitHub Pages to deploy the site.
Testing
Test Label | Test Action | Expected Outcome | Test Outcome |
---|---|---|---|
HTML Validator | Check for any warnings or errors at HTML Validator | No warnings or errors reported | PASS |
CSS Validator | Check for any warnings or errors at CSS Validator | No warnings or errors reported | PASS |
Opening browser | Opening the website browser by google chrone, microsoft edge and phones | Website can be opened | PASS |
Screen Size | resizing screen for any sizes above 300 pixels | Website is responsive when screen changes size to fit | PASS |
Selecting grey square | Selecting grey square before pressing start button | Nothing happens | PASS |
Selecting start button | Selecting start button colored blue | Round starts, one of the square flashes green, then all squares colored blue | PASS |
Selecting start button mid-game | In mid-game, select start button colored grey mid-game | Nothing happens | PASS |
Selecting correct square | In mid-game, select blue square that was flashed green | Selected square flashes green, starting next round | PASS |
Selecting incorrect square | In mid-game select blue square that was not flashed green | Selected square colored red, correct square colored green, ending the game | PASS |
Timer end | In mid-game, do nothing and let timer ends | Timer ticks down every second, ends the game when timer reaches zero | PASS |
Restart Game | After game ends, press restart button colored blue | Game restarted and starts again | PASS |
Known Bugs
There are currently no known bugs
Deployment
Adding and Committing files
To add files to the repository take the following steps
In the command line type -
git add .
git commit -m "This is being committed"
git push
To add all new files or modified file use " ." - To add a single file use the pathway to the file eg .index.html or assets/css/style.css When committing make sure your comments are clear about what changes have been made. Pushing will send your work to the repository
Deployment
The project was deployed with the following steps
- Logged into git hub
- Clicked the "Settings" button in the menu above the Repository.
- Scroll down the Settings page to the "GitHub Pages" Section.
- Under "Source", click the dropdown called "None" and then select "Master Branch".
- The page will automatically refresh, and a link displaced. It may take some time for the link to show the website.
- If the page will not load go down to "template" under the "source" and select a template.
- Scroll back down through the page to locate the now published site link in the "GitHub Pages" section.
- Website gets automatically updated on every commits push from master branch
Forking
By forking the GitHub Repository, you can make a copy of the original repository in your own GitHub account. This means we can view or make changes without making the changes affecting the original.
- Log into GitHub and locate the GitHub Repository.
- At the top of the Repository there is a "Fork" button about the "Settings" button on the menu.
- You should now have a new copy of the original repository in your own GitHub account.
Cloning
-
Log into your GitHub then find the gitpod repository
-
Under the repository name there is a button that says "Clone or download". Click on this button.
-
If cloning with HTTPS "Clone with HTTPS", copy this link.
-
Open Gitbash
-
Change the current working directory to the location where you want the cloned directory to be.
-
Type git clone, and then paste the URL you copied earlier.
$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY Press - Enter- Your local clone will be created. $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY > Cloning into `CI-Clone`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. > remove: Total 10 (delta 1), reused 10 (delta 1) > Unpacking objects: 100% (10/10), done.
Click Here for more info on cloning.