/trivia-game

This is a Trivia game project that I initiate at my front-end course, I'm looking for contributors to improve the game by adding a backend and extending the gameplay. The contributing guidelines encourage collaboration, following the code of conduct, creating issues, providing test cases, and maintaining a professional and respectful demeanor.

Primary LanguageJavaScriptMIT LicenseMIT

Trivia Game

Welcome to the React Trivia Game! This is a simple trivia game built on React, which uses ESLint, Cypress, RTL, Jest, CSS, and JavaScript.

Installation

To install the Trivia Game, please follow the steps below:

  1. Ensure that you have Node.js at version 18 and npm installed on your computer. If you don't, you can download them from the official Node.js website https://nodejs.org/en/. I recommend NVM for the manage of node's version, you can download it from the official nvm repository https://github.com/nvm-sh/nvm.

  2. Clone this repository to your local machine using the following command:

git clone git@github.com:ramonbs/trivia-game.git
  1. Navigate into the project directory:
cd trivia-game
  1. Install the required dependencies using npm:
npm install

This command will install all the required packages, including ESLint, RTL, and Jest.

Usage

To run the Trivia Game, use the following command:

npm start

This will start a development server, which will allow you to view the game in your web browser. By default, the game will be available at http://localhost:3000.

Testing

To run the tests for the Trivia Game, use the following command:

npm test

This will run the Jest test suite, which will test the functionality of the application.

Contributing

If you would like to contribute to the Trivia Game, please follow the steps below:

  1. Fork this repository to your own GitHub account.

  2. Clone your fork to your local machine.

  3. Make changes to the code on your local machine.

  4. Test your changes thoroughly.

  5. Commit your changes and push them to your fork.

  6. Create a pull request to merge your changes back into the main repository.

We appreciate your contributions to the Trivia Game!