Quizzical Quizzical is a web-based quiz application built with Vite and React.
Table of Contents Features Installation Usage Deployment Contributing License
Features Take quizzes and view results Authentication and authorization for users RESTful API for questions Installation
To run the project, you'll need to have Node.js and npm installed. Here are the steps to install and set up the project:
Clone the repository: bash Copy code git clone https://github.com/BSMuse/quizzical.git Install the dependencies: bash Copy code cd quizzical npm install
Usage To start the development server, run the following command from the root directory:
Copy code npm run dev This will start the development server at http://localhost:3000/.
Deployment To deploy the project, you can use Vite's built-in static file serving. Here are the steps to deploy the project to a production environment:
Build the project: Copy code npm run build This will create a production-ready build of the project in the dist directory.
Serve the built files: Copy code npm run serve This will serve the built files using Vite's built-in static file serving. You can access the deployed site at http://localhost:5000/.
Contributing If you'd like to contribute to the project, please follow these steps:
Fork the repository. Create a new branch. Make your changes and commit them with descriptive commit messages. Push your changes to your forked repository. Submit a pull request. Please make sure to write clear and concise commit messages, and follow the project's code style and guidelines.
License This project is licensed under the MIT License - see the LICENSE file for details.