Skip to content

Commit 0dfcb7c

Browse files
Merge pull request #571 from Temmarie/indexmd
Fix Markdown issues in Index.md file
2 parents 9d90c2d + 6bbc6e4 commit 0dfcb7c

23 files changed

+5862
-134
lines changed

Index.md

Lines changed: 92 additions & 134 deletions
Large diffs are not rendered by default.

quiz-app/.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

quiz-app/README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Quiz App
2+
3+
4+
5+
This is a simple, interactive quiz application built with React and styled using TailwindCSS. The app allows users to go through a series of questions, provides feedback on their answers, and displays a final score upon completion.
6+
7+
## Screenshots
8+
<table>
9+
<tr>
10+
<td>
11+
<h3>Welcome Screen</h3>
12+
<img src="https://github.com/Temmarie/Web-dev-mini-projects/blob/quiz-app/quiz-app/src/assets/images/welcome.png" alt="Welcome Screen" width="100%"/>
13+
</td>
14+
<td>
15+
<h3>Instructions Screen</h3>
16+
<img src="https://github.com/Temmarie/Web-dev-mini-projects/blob/quiz-app/quiz-app/src/assets/images/instructions.png" alt="Instructions Screen" width="100%"/>
17+
</td>
18+
</tr>
19+
<tr>
20+
<td>
21+
<h3>Quiz Screen</h3>
22+
<img src="https://github.com/Temmarie/Web-dev-mini-projects/blob/quiz-app/quiz-app/src/assets/images/quiz.png" alt="Quiz Screen" width="100%"/>
23+
</td>
24+
<td>
25+
<h3>Score Screen</h3>
26+
<img src="https://github.com/Temmarie/Web-dev-mini-projects/blob/quiz-app/quiz-app/src/assets/images/score.png" alt="Completion Screen" width="100%"/>
27+
</td>
28+
</tr>
29+
</table>
30+
31+
## Table of Contents
32+
33+
- [Features](#features)
34+
- [Technologies Used](#technologies-used)
35+
- [Getting Started](#getting-started)
36+
37+
38+
## Features
39+
40+
- **Welcome Screen**: Users are greeted with a welcome screen where they can choose to start the quiz or view instructions.
41+
- **Instructions**: An optional instructions screen explaining how to navigate and answer the quiz.
42+
- **Question Display**: Each question is displayed one at a time with multiple answer choices.
43+
- **Feedback**: Users receive instant feedback after answering each question.
44+
- **Progress Indicator**: The app tracks the user's progress, indicating how many questions they have answered and how many are left.
45+
- **Score Tracking**: The app calculates the final score and displays it upon quiz completion.
46+
- **Responsive Design**: Fully responsive and mobile-friendly UI using TailwindCSS.
47+
48+
## Built With
49+
50+
- **React**
51+
- **TailwindCSS**
52+
- **Vite**
53+
54+
## Getting Started
55+
56+
To get a local copy up and running follow these simple example steps.
57+
58+
### Prerequisites
59+
60+
- **Node.js** (v14 or above)
61+
- **npm** or **yarn**
62+
63+
### Setup
64+
65+
1. Clone the repository:
66+
67+
`
68+
git clone https://github.com/temmarie/quiz-app.git
69+
cd quiz-app
70+
```
71+
72+
2. Install dependencies:
73+
74+
```
75+
npm install
76+
```
77+
78+
3. Start the development server:
79+
80+
```
81+
npm run dev
82+
```
83+
84+
4. Open your browser and navigate to:
85+
86+
```
87+
http://localhost:5173
88+
```

quiz-app/eslint.config.js

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import js from '@eslint/js'
2+
import globals from 'globals'
3+
import react from 'eslint-plugin-react'
4+
import reactHooks from 'eslint-plugin-react-hooks'
5+
import reactRefresh from 'eslint-plugin-react-refresh'
6+
7+
export default [
8+
{ ignores: ['dist'] },
9+
{
10+
files: ['**/*.{js,jsx}'],
11+
languageOptions: {
12+
ecmaVersion: 2020,
13+
globals: globals.browser,
14+
parserOptions: {
15+
ecmaVersion: 'latest',
16+
ecmaFeatures: { jsx: true },
17+
sourceType: 'module',
18+
},
19+
},
20+
settings: { react: { version: '18.3' } },
21+
plugins: {
22+
react,
23+
'react-hooks': reactHooks,
24+
'react-refresh': reactRefresh,
25+
},
26+
rules: {
27+
...js.configs.recommended.rules,
28+
...react.configs.recommended.rules,
29+
...react.configs['jsx-runtime'].rules,
30+
...reactHooks.configs.recommended.rules,
31+
'react/jsx-no-target-blank': 'off',
32+
'react-refresh/only-export-components': [
33+
'warn',
34+
{ allowConstantExport: true },
35+
],
36+
},
37+
},
38+
]

quiz-app/index.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>Quiz App</title>
7+
</head>
8+
<body>
9+
<div id="root"></div>
10+
<script type="module" src="/src/main.jsx"></script>
11+
</body>
12+
</html>

0 commit comments

Comments
 (0)