Skip to content

elvinlab/PokeQuizAdventureGame

Repository files navigation

PokeQuizAdventureGame

PokeQuizAdventureGame

Description

PokeQuizAdventureGame is a Pokémon-based quiz game. This project utilizes several modern technologies to create an interactive and dynamic user experience.

Environment Requirements

Before getting started, make sure you have the following installed on your system:

  • Node.js (version 16 or higher)
  • pnpm (package manager)

Installation

  1. Clone the repository:

    git clone https://github.com/elvinlab/PokeQuizAdventureGame
    cd pokequizadventuregame
  2. Install the dependencies:

    pnpm install

Available Scripts

In this project, you can run the following scripts:

  • Development:

    pnpm dev

    This command starts the development server using Vite.

  • Build:

    pnpm build

Running Tests

To run tests for this project, use the following command:

pnpm Test

This command builds the project for production.

  • Preview:
    pnpm preview
    This command allows you to preview the built project.

Dependencies

Production

  • animate.css: A library of ready-to-use CSS animations.
  • axios: Promise-based HTTP client for the browser and Node.js.
  • flowbite: UI components built with Tailwind CSS.
  • vue: Progressive framework for building user interfaces.
  • vue-i18n: Internationalization plugin for Vue.js.
  • vue-router: Official router for Vue.js.

Development

  • @vitejs/plugin-vue: Plugin to integrate Vue with Vite.
  • @vue/test-utils: Utilities for testing Vue components.
  • @vue/vue3-jest: Jest integration for Vue 3.
  • autoprefixer: Plugin to parse CSS and add vendor prefixes using values from Can I Use.
  • babel-jest: Jest transformer for JavaScript ES6+ syntax.
  • jest-environment-jsdom: Jest environment that simulates a browser environment using jsdom.
  • jest: JavaScript testing framework.
  • postcss: Tool to transform CSS with JavaScript plugins.
  • tailwindcss: Utility-first CSS framework for quickly building custom designs.
  • vite: Fast build tool focused on the frontend.

Running the Project Locally

  1. Start the development server:

    pnpm dev
  2. Open your browser and navigate to:

    http://localhost:5173/
    

Contributions

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a branch (git checkout -b feature/new-feature).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push your changes (git push origin feature/new-feature).
  5. Open a Pull Request.

Thank you for your interest in PokeQuizAdventureGame! If you have any questions or suggestions, feel free to open an issue or send an email.

Have fun playing and learning about Pokémon!