Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusha0123/quiz-app
Quiz app built using Next.js, utilizing the TRIVIA API for the questions database.
https://github.com/yusha0123/quiz-app
nextjs shadcn-ui taildwindcss trivia-quiz-game typescript
Last synced: about 2 months ago
JSON representation
Quiz app built using Next.js, utilizing the TRIVIA API for the questions database.
- Host: GitHub
- URL: https://github.com/yusha0123/quiz-app
- Owner: yusha0123
- Created: 2023-06-12T06:02:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-18T11:52:19.000Z (5 months ago)
- Last Synced: 2024-12-08T02:42:04.585Z (2 months ago)
- Topics: nextjs, shadcn-ui, taildwindcss, trivia-quiz-game, typescript
- Language: TypeScript
- Homepage: https://quizy-yusha.vercel.app/
- Size: 466 KB
- Stars: 43
- Watchers: 1
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quiz App
Welcome to the Quiz App! This application is designed to provide an interactive and engaging way to test your knowledge on various topics. Built with modern technologies, this app ensures a smooth and responsive user experience.
## Table of Contents
- [Demo](#demo)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [API](#api)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Demo
Check out the live demo of the Quiz App [here](https://quizy-yusha.vercel.app/).
## Features
- Interactive quizzes with multiple choice questions
- Real-time feedback on answers
- Score tracking and result display
- Responsive design for all devices
## Tech Stack
- **Framework**: [Next.js 14](https://nextjs.org/)
- **Styling**: [TailwindCSS](https://tailwindcss.com/)
- **Language**: [TypeScript](https://www.typescriptlang.org/)
- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/)
- **UI Components**: [Shad CN/UI](https://ui.shadcn.com/)
## API
This project uses [The Trivia API](https://the-trivia-api.com/) to fetch quiz questions.
## Getting Started
To get a local copy up and running, follow these simple steps.
### Prerequisites
Ensure you have the following installed:
- [Node.js](https://nodejs.org/) (v14 or later)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
### Installation
1. Clone the repository
```sh
git clone https://github.com/yusha0123/Quiz-App.git
```
2. Navigate to the project directory
```sh
cd Quiz-App
```
3. Install dependencies
```sh
npm install
```
or
```sh
yarn install
```
### Usage
1. Start the development server
```sh
npm run dev
```
or
```sh
yarn dev
```
2. Open [http://localhost:3000](http://localhost:3000) with your browser to see the app in action.
### Building for Production
To create a production build, run:
```sh
npm run build
```
or
```sh
yarn build
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Yusha Tahlil - [LinkedIn](https://www.linkedin.com/in/yusha-tahlil/)
Project Link: [https://github.com/yusha0123/Quiz-App](https://github.com/yusha0123/Quiz-App)