Skip to content

Commit 190d4b7

Browse files
Amey-ThakurAmey-Thakur
committed
THE-MATH-GAME
1 parent eeb58d8 commit 190d4b7

1 file changed

Lines changed: 216 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 216 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,226 @@
1-
# THE-MATH-GAME
1+
<div align="center">
22

3-
👉🏻 It is a simple multiplication game to test how well we are at arithmetic.
4-
5-
>**[Try The Web Application](https://amey-thakur.github.io/THE-MATH-GAME)**
3+
<a name="readme-top"></a>
4+
# The Math Game
5+
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-lightgrey)](LICENSE)
7+
![Status](https://img.shields.io/badge/Status-Completed-success)
8+
[![Technology](https://img.shields.io/badge/Technology-HTML5%20%7C%20JavaScript-orange)](https://github.com/Amey-Thakur/THE-MATH-GAME)
9+
[![Developed by Amey Thakur and Mega Satish](https://img.shields.io/badge/Developed%20by-Amey%20Thakur%20%26%20Mega%20Satish-blue.svg)](https://github.com/Amey-Thakur/THE-MATH-GAME)
10+
11+
A simple, interactive multiplication game designed to test and improve arithmetic skills through rapid-fire problem solving.
12+
13+
**[Source Code](Source%20Code/)** &nbsp;·&nbsp; **[Technical Specification](docs/SPECIFICATION.md)** &nbsp;·&nbsp; **[Live Demo](https://amey-thakur.github.io/THE-MATH-GAME/)**
14+
15+
</div>
16+
17+
---
18+
19+
<div align="center">
20+
21+
[Authors](#authors) &nbsp;·&nbsp; [Overview](#overview) &nbsp;·&nbsp; [Features](#features) &nbsp;·&nbsp; [Structure](#project-structure) &nbsp;·&nbsp; [Results](#system-architecture--design-gallery) &nbsp;·&nbsp; [Quick Start](#quick-start) &nbsp;·&nbsp; [Usage Guidelines](#usage-guidelines) &nbsp;·&nbsp; [License](#license) &nbsp;·&nbsp; [About](#about-this-repository) &nbsp;·&nbsp; [Acknowledgments](#acknowledgments)
22+
23+
</div>
24+
25+
---
26+
27+
<!-- AUTHORS -->
28+
<div align="center">
29+
30+
<a name="authors"></a>
31+
## Authors
32+
33+
**Terna Engineering College | Computer Engineering | Batch of 2022**
34+
35+
| <a href="https://github.com/Amey-Thakur"><img src="https://github.com/Amey-Thakur.png" width="150" height="150" alt="Amey Thakur"></a><br>[**Amey Thakur**](https://github.com/Amey-Thakur)<br><br>[![ORCID](https://img.shields.io/badge/ORCID-0000--0001--5644--1575-green.svg)](https://orcid.org/0000-0001-5644-1575) | <a href="https://github.com/msatmod"><img src="Mega/Mega.png" width="150" height="150" alt="Mega Satish"></a><br>[**Mega Satish**](https://github.com/msatmod)<br><br>[![ORCID](https://img.shields.io/badge/ORCID-0000--0002--1844--9557-green.svg)](https://orcid.org/0000-0002-1844-9557) |
36+
| :---: | :---: |
37+
38+
</div>
39+
40+
> [!IMPORTANT]
41+
> ### 🤝🏻 Special Acknowledgement
42+
> *Special thanks to **[Mega Satish](https://github.com/msatmod)** for her meaningful contributions, guidance, and support that helped shape this work.*
643
744
---
845

9-
>**WEB APPLICATION - https://amey-thakur.github.io/THE-MATH-GAME**
46+
<!-- OVERVIEW -->
47+
<a name="overview"></a>
48+
## Overview
1049

11-
![image](https://user-images.githubusercontent.com/54937357/154539531-9b586eed-c2d0-44f4-8e8d-a0c00fd66b95.png)
50+
**The Math Game** is an educational web application focused on strengthening multiplication skills. It presents users with random arithmetic problems and multiple-choice answers, requiring quick thinking and accuracy.
1251

13-
![image](https://user-images.githubusercontent.com/54937357/154540683-a58dad77-dabd-4bbe-bab4-59af34f2e9d1.png)
52+
The project demonstrates the use of JavaScript for game logic, including random number generation, score keeping, and timer management, providing an engaging way to practice mental math.
1453

15-
![image](https://user-images.githubusercontent.com/54937357/154540932-927369bf-1e9c-4419-8dd1-c734dae04317.png)
54+
> [!TIP]
55+
> **Educational Value**
56+
>
57+
> Simple gamification elements like score tracking and immediate feedback mechanisms are effective in reinforcing learning and improving calculation speed.
1658
1759
---
1860

19-
<p align="center"> <b> 👉🏻 Created The Math Game 👈🏻 <b> </p>
20-
21-
<p align="center"><a href='https://github.com/Amey-Thakur/COMPUTER-ENGINEERING', style='color: greenyellow;'> ✌🏻 Back To Engineering ✌🏻</p>
61+
<!-- FEATURES -->
62+
<a name="features"></a>
63+
## Features
64+
65+
| Feature | Description |
66+
|---------|-------------|
67+
| **Multiplication Drills** | Randomized multiplication problems to challenge the player. |
68+
| **Score System** | Real-time score tracking to monitor progress. |
69+
| **Timer Constraint** | Time-limited rounds to encourage rapid mental processing. |
70+
| **Responsive UI** | Clean and accessible interface suitable for all devices. |
71+
| **Immediate Feedback** | Visual cues for correct and incorrect answers. |
72+
73+
### Tech Stack
74+
- **Languages**: HTML5, CSS3, JavaScript
75+
- **Framework**: Vanilla JS
76+
- **Deployment**: GitHub Actions (Staging Workflow)
77+
- **Hosting**: GitHub Pages
78+
79+
---
80+
81+
<!-- STRUCTURE -->
82+
<a name="project-structure"></a>
83+
## Project Structure
84+
85+
```python
86+
THE-MATH-GAME/
87+
│
88+
├── .github/ # GitHub Actions & Automation
89+
│ └── workflows/
90+
│ └── deploy.yml # Automated Staging & Deployment Flow
91+
│
92+
├── docs/ # Technical Documentation
93+
│ └── SPECIFICATION.md # Architecture & Design Specification
94+
│
95+
├── Mega/ # Project Resources & Assets
96+
│ └── Mega.png # Author Profile Image
97+
│
98+
├── Source Code/ # Primary Application Layer
99+
│ ├── styling.css # Game Visuals
100+
│ ├── javascript.js # Game Logic
101+
│ ├── images/ # Game Assets
102+
│ └── index.html # Game Entry Point
103+
│
104+
├── .gitattributes # Git configuration
105+
├── CITATION.cff # Scholarly Citation Metadata
106+
├── codemeta.json # Machine-Readable Project Metadata
107+
├── LICENSE # MIT License Terms
108+
├── README.md # Comprehensive Archival Entrance
109+
└── SECURITY.md # Security Policy & Protocol
110+
```
111+
112+
---
113+
114+
<!-- RESULTS -->
115+
<a name="system-architecture--design-gallery"></a>
116+
## System Architecture & Design Gallery
117+
118+
<div align="center">
119+
<img src="https://user-images.githubusercontent.com/54937357/154539531-9b586eed-c2d0-44f4-8e8d-a0c00fd66b95.png" alt="Start Screen" width="80%">
120+
<br>
121+
*Game Start Screen*
122+
123+
<br><br>
124+
125+
<img src="https://user-images.githubusercontent.com/54937357/154540683-a58dad77-dabd-4bbe-bab4-59af34f2e9d1.png" alt="Correct Answer" width="60%">
126+
<br>
127+
*Gameplay - Correct Answer Feedback*
128+
129+
<br><br>
130+
131+
<img src="https://user-images.githubusercontent.com/54937357/154540932-927369bf-1e9c-4419-8dd1-c734dae04317.png" alt="Game Over" width="60%">
132+
<br>
133+
*Game Over Summary*
134+
</div>
135+
136+
---
137+
138+
<!-- QUICK START -->
139+
<a name="quick-start"></a>
140+
## Quick Start
141+
142+
### 1. Prerequisites
143+
- **Browser**: Any modern web browser.
144+
- **Connection**: Internet connection required for initial loading (if using external fonts/assets).
145+
146+
### 2. Setup & Deployment
147+
1. **Clone the Repository**:
148+
```bash
149+
git clone https://github.com/Amey-Thakur/THE-MATH-GAME.git
150+
cd THE-MATH-GAME
151+
```
152+
2. **Launch**:
153+
Open `Source Code/index.html` in your preferred browser.
154+
155+
---
156+
157+
<!-- =========================================================================================
158+
USAGE SECTION
159+
========================================================================================= -->
160+
## Usage Guidelines
161+
162+
This repository is shared to encourage open learning and collaboration.
163+
164+
**For Students**
165+
Analyze the JavaScript logic to understand how to handle game states, timers, and user interactions in a web environment.
166+
167+
**For Educators**
168+
Use this as a simple example of gamification in education or as a starter project for introduction to web development.
169+
170+
---
171+
172+
<!-- LICENSE -->
173+
<a name="license"></a>
174+
## License
175+
176+
This repository and all its creative and technical assets are made available under the **MIT License**. See the [LICENSE](LICENSE) file for complete terms.
177+
178+
> [!NOTE]
179+
> **Summary**: You are free to share and adapt this content for any purpose, even commercially, as long as you provide appropriate attribution to the original author.
180+
181+
Copyright © 2022 Amey Thakur, Mega Satish
182+
183+
---
184+
185+
<!-- ABOUT -->
186+
<a name="about-this-repository"></a>
187+
## About This Repository
188+
189+
**Created & Maintained by**: [Amey Thakur](https://github.com/Amey-Thakur) & [Mega Satish](https://github.com/msatmod)
190+
**Academic Journey**: Bachelor of Engineering in Computer Engineering (2018-2022)
191+
**Institution**: [Terna Engineering College](https://ternaengg.ac.in/), Navi Mumbai
192+
**University**: [University of Mumbai](https://mu.ac.in/)
193+
194+
This project features **The Math Game**, developed as a **Human Machine Interaction** project during the engineering curriculum. It aims to make learning arithmetic fun and interactive through web technology.
195+
196+
**Connect:** [GitHub](https://github.com/Amey-Thakur) &nbsp;·&nbsp; [LinkedIn](https://www.linkedin.com/in/amey-thakur) &nbsp;·&nbsp; [ORCID](https://orcid.org/0000-0001-5644-1575)
197+
198+
### Acknowledgments
199+
200+
Grateful acknowledgment to [**Mega Satish**](https://github.com/msatmod) for her exceptional collaboration and scholarly partnership during the development of this arithmetic game project. Her constant support, technical clarity, and dedication to software quality were instrumental in achieving the system's functional objectives. Learning alongside her was a transformative experience; her thoughtful approach to problem-solving and steady encouragement turned complex requirements into meaningful learning moments. This work reflects the growth and insights gained from our side-by-side academic journey. Thank you, Mega, for everything you shared and taught along the way.
201+
202+
Grateful acknowledgment to the faculty members of the **Department of Computer Engineering** at Terna Engineering College for their guidance and instruction in Human Machine Interaction. Their expertise and support helped develop a strong understanding of interactive system design.
203+
204+
Special thanks to the mentors and peers whose encouragement, discussions, and support contributed meaningfully to this learning endeavor.
205+
206+
---
207+
208+
<div align="center">
209+
210+
[↑ Back to Top](#readme-top)
211+
212+
[Authors](#authors) &nbsp;·&nbsp; [Overview](#overview) &nbsp;·&nbsp; [Features](#features) &nbsp;·&nbsp; [Structure](#project-structure) &nbsp;·&nbsp; [Results](#system-architecture--design-gallery) &nbsp;·&nbsp; [Quick Start](#quick-start) &nbsp;·&nbsp; [Usage Guidelines](#usage-guidelines) &nbsp;·&nbsp; [License](#license) &nbsp;·&nbsp; [About](#about-this-repository) &nbsp;·&nbsp; [Acknowledgments](#acknowledgments)
213+
214+
<br>
215+
216+
🔬 **[Human Machine Interaction Laboratory](https://github.com/Amey-Thakur/HUMAN-MACHINE-INTERACTION-AND-HUMAN-MACHINE-INTERACTION-LAB)** &nbsp; · &nbsp; ✖️ **[THE-MATH-GAME](https://amey-thakur.github.io/THE-MATH-GAME)**
217+
218+
---
219+
220+
### 🎓 [Computer Engineering Repository](https://github.com/Amey-Thakur/COMPUTER-ENGINEERING)
221+
222+
**Computer Engineering (B.E.) - University of Mumbai**
223+
224+
*Semester-wise curriculum, laboratories, projects, and academic notes.*
225+
226+
</div>

0 commit comments

Comments
 (0)