Skip to content

Commit c12d219

Browse files
Update README.md
1 parent 4a6ccd6 commit c12d219

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
1-
---
2-
---
1+
-----
2+
-----
33

4-
# 🧠 MINDMASH Application: C Programming Series & Quizzes
4+
# 🧠 C Programming Series Application
55

6-
This repository contains the front-end code for **MINDMASH**, an application designed by The Coders Club. It serves as a comprehensive platform for a C Programming Series, featuring structured weekly content, interactive quizzes, a feedback mechanism, and a dynamic leaderboard.
6+
This repository contains the front-end code for **C Programming Series**, an application designed by The Coders Club. It serves as a comprehensive platform for a C Programming Series, featuring structured weekly content, interactive quizzes, a feedback mechanism, and a dynamic leaderboard.
77

88
-----
99

1010
## ✨ Features
1111

12-
* **C Programming Series Content (Homepage - `index.html`)**:
12+
* **C Programming Series Overview (Homepage - `index.html`)**:
13+
14+
* Provides a welcoming introduction to the C Programming Series.
15+
* **Weekly Topics Overview Table**: Summarizes the topics covered in each week, including their access status.
16+
* **Meet Our Board Members**: Introduces the dedicated individuals leading The Coders Club and their roles.
17+
* **What Our Participants Say**: Features testimonials from previous participants.
18+
* **Other Series**: Information on other programming series offered or upcoming.
19+
20+
* **C Programming Series Detailed Content (`weeklycontent.html`)**:
1321

14-
* **Structured Weekly Content**: Navigate through C programming content organized by weeks.
22+
* **Structured Weekly Content**: Navigates users through C programming content organized by weeks.
1523
* **Daily Learning Modules**: Each week breaks down into daily sections (Monday, Tuesday, etc.), offering focused learning.
1624
* **Dynamic Content Access**: Weeks and individual days can be configured to display content as **blurred and jumbled text** if they are disabled (e.g., "Coming Soon" or "Access Closed"). This provides a clear visual cue while allowing users to still click the navigation buttons.
1725
* **Responsive Tab Navigation**: Week and day selection buttons are fully responsive, gracefully adapting to different screen sizes and maintaining a consistent, sleek appearance on both desktop and mobile devices.
1826
* **Code Snippets & Examples**: Content includes clearly formatted code blocks for hands-on learning.
1927

2028
* **Interactive Quiz Forms**:
2129

22-
* **Weekly Quiz (`quiz.html`)**: For regular, weekly assessments.
23-
* **Final Quiz (`finalquiz.html`)**: For a comprehensive final assessment.
30+
* **Weekly Quiz (`quiz.html`)**: For regular, weekly assessments based on the content of a single week.
31+
* **Final Quiz (`finalquiz.html`)**: A comprehensive final assessment covering content from Week 1 to Week 5, structurally similar to the weekly quiz.
2432
* Both quiz forms allow users to answer multiple-choice, multi-select, and open-ended questions.
2533
* **No Hint Text**: All text input fields and text areas (including Name and Email) are intentionally left blank, providing no hints or placeholder text.
2634
* Each quiz can be **enabled or disabled** via a simple JavaScript variable for active control.
@@ -43,6 +51,12 @@ This repository contains the front-end code for **MINDMASH**, an application des
4351

4452
* **Google Sheets Integration**: Submits quiz and feedback form data directly to Google Sheets using a Google Apps Script web app (requires user setup).
4553

54+
* **Custom Styling (`styles.css`)**:
55+
56+
* **Consistent Theme**: Centralized styling ensures a cohesive look and feel across all pages.
57+
* **"Liquid Glass" Secondary Menu**: Features a uniquely styled secondary navigation menu (`.button-container` and `.nav-button`) with a transparent, gradient "liquid glass" effect.
58+
* **Enhanced Responsiveness**: The secondary menu is specifically optimized to display all navigation buttons on a **single horizontal row** across various mobile screen sizes, maintaining a readable font size and preventing horizontal scrollbars. This may result in minor clipping of content on the very narrowest devices, a deliberate trade-off for the desired compact layout.
59+
4660
-----
4761

4862
## 🚀 Setup & Usage
@@ -123,8 +137,8 @@ Both the quiz and feedback forms submit data to a Google Sheet via a deployed Go
123137
* Open `feedback.html`.
124138
* Find the line: `const formControlStatus = "disable";`
125139
* Change `"disable"` to `"enable"` to make the feedback form active.
126-
* **For the C Programming Series Content (`index.html`)**:
127-
* Open `index.html`.
140+
* **For the C Programming Series Content (`weeklycontent.html`)**:
141+
* Open `weeklycontent.html`.
128142
* Locate the JavaScript section that defines `disabledWeekId` and `disabledDays`.
129143
* Adjust `let disabledWeekId = '';` to specify a week ID (e.g., `'week4'`) to disable an entire week's content.
130144
* Modify `const disabledDays = {};` to include specific days within an enabled week (e.g., `{'week1': ['tuesday', 'thursday']}`) to show those day's content as blurred and jumbled.
@@ -142,15 +156,16 @@ The leaderboard data in `leaderboard.html` is currently **static HTML**. This me
142156

143157
## 💻 Local Development
144158

145-
You can open `index.html`, `quiz.html`, `finalquiz.html`, `feedback.html`, and `leaderboard.html` directly in your web browser to test them. Remember that for form submissions and dynamic content status to work, you *must* have completed the Google Apps Script setup and updated the relevant JavaScript variables in the HTML files.
159+
You can open `index.html`, `weeklycontent.html`, `quiz.html`, `finalquiz.html`, `feedback.html`, and `leaderboard.html` directly in your web browser to test them. Remember that for form submissions and dynamic content status to work, you *must* have completed the Google Apps Script setup and updated the relevant JavaScript variables in the HTML files.
146160

147161
-----
148162

149163
## 📄 File Structure
150164

151-
* `index.html`: The **homepage** featuring the C Programming Series weekly and daily content.
165+
* `index.html`: The **homepage** featuring the C Programming Series overview, board members, testimonials, and other series.
166+
* `weeklycontent.html`: Contains the detailed **C Programming Series weekly and daily learning content**.
152167
* `quiz.html`: The interactive **Weekly Quiz** application page.
153-
* `finalquiz.html`: The interactive **Final Quiz** application page.
168+
* `finalquiz.html`: The interactive **Final Quiz** application page for the entire series.
154169
* `feedback.html`: The Feedback form page.
155170
* `leaderboard.html`: Displays the quiz results with weekly and department-wise filtering.
156171
* `styles.css`: Contains the common CSS styling for all pages.
@@ -173,5 +188,3 @@ This project is open-sourced under the MIT License.
173188
## 📧 Contact
174189

175190
For any questions or suggestions, please contact The Coders Club.
176-
177-
-----

0 commit comments

Comments
 (0)