Skip to content

CodeStrate/QuizApp

Repository files navigation

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 and Yarn installed on your machine.

  1. Clone the repository to your local machine:

    git clone https://github.com/CodeStrate/QuizApp.git
  2. Navigate to the project directory:

    cd QuizApp
  3. Install the project dependencies:

    yarn install

Usage

Development

To run the Quiz App in development mode, you can use Yarn:

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:

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 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. 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!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published