Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codestrate/quizapp
https://github.com/codestrate/quizapp
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/codestrate/quizapp
- Owner: CodeStrate
- Created: 2023-07-28T16:24:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-25T13:16:05.000Z (3 months ago)
- Last Synced: 2024-08-25T14:35:51.986Z (3 months ago)
- Language: JavaScript
- Size: 26.7 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quiz App
Welcome to the Quiz App, a React-based quiz application that leverages the Open Trivia Database API to provide you with endless trivia questions. This app is highly customizable, has a simplistic UI design, and is open source for you to explore and contribute to. Here's how to get started:
## Installation
Before you begin, ensure you have [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed on your machine.
1. Clone the repository to your local machine:
```bash
git clone https://github.com/CodeStrate/QuizApp.git
```
2. Navigate to the project directory:
```bash
cd QuizApp
```
3. Install the project dependencies:
```bash
yarn install
```
## Usage
### Development
To run the Quiz App in development mode, you can use Yarn:
```bash
yarn dev
```
This command will start a development server and open the app in your default web browser. You can make changes to the code, and the app will automatically reload to reflect your changes.
### Building for Production
To build the Quiz App for production, use the following command:
```bash
yarn build
```
This command will generate a production-ready build in the `dist` directory.
### Customization
One of the key features of this app is its customizability. You can easily modify various options for the quiz:
- **Type:** Choose from various question types.
- **Difficulty:** Select the difficulty level of questions.
- **Topic:** Specify a topic for the questions.
- **Count:** Set the number of questions in the quiz.
Feel free to tailor these options to create a unique quiz experience.
### Issues
If you encounter any issues or have suggestions for improvements, please check my [GitHub Issues](https://github.com/CodeStrate/QuizApp/issues) page. You can submit new issues or contribute to existing ones to help make the app better.
### Goals
We have exciting goals for the Quiz App:
- **Leaderboards:** Implement a leaderboard system to track users' scores.
- **Timers:** Add timers to create time-based challenges.
- **Hint System:** Develop a hint system to assist users in answering questions.
- **Mobile Port:** Explore the possibility of creating a mobile version of the app.
Your contributions and ideas are welcomed as we work towards these goals.
### Deployment
You can access the live version of the Quiz App on [Netlify](https://the-quiz-pro-max-codestrate.netlify.app/). It's hosted there for your convenience.
## Contributing
We welcome contributions from the community. To contribute, follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive commit messages.
4. Push your branch to your fork.
5. Create a pull request to the `main` branch of the original repository.
Please follow the contribution guidelines and coding standards when making changes.
Thank you for your interest in the Quiz App. I hope you enjoy using and contributing to it!