Tenzies Warm-up

A simple warm-up React project to implement the game Tenzies.

Project Description

Tenzies Warm-up is a simple React project designed to refresh React skills by recreating the Tenzies game.

Features

• Three difficulty modes: Easy, Normal, Hard
• Tracks time and number of clicks needed to win
• Displays top 5 best results on the dashboard

Notable Libraries and Technologies

• React: A JavaScript library for building user interfaces.
• TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
• Vite: A build tool that provides a faster and leaner development experience for modern web projects.
• Jest: A delightful JavaScript testing framework with a focus on simplicity.
• ESLint: A static code analysis tool for identifying problematic patterns found in JavaScript code.
• Prettier: An opinionated code formatter.
• Husky: Git hooks made easy.
• Lint-staged: Run linters on git staged files.
• Date-fns: Modern JavaScript date utility library.
• Lodash: A modern JavaScript utility library delivering modularity, performance & extras.
• React-use: A collection of essential React Hooks.
• TailwindCSS: A utility-first CSS framework for rapidly building custom user interfaces.
• Cypress: Fast, easy and reliable testing for anything that runs in a browser.
• React Confetti: Confetti for React applications.

Table of Contents

• Installation
• Usage
• Scripts
• Dependencies
• Dev Dependencies
• Author
• License

Installation

1. Clone the repository: git clone https://github.com/yourusername/tenzies-warmup.git
2. Navigate to the project directory: cd tenzies-warmup
3. Install the dependencies: yarn install

Usage

To start the development server, run: yarn run dev

To build the project for production, run: yarn run build

To preview the production build, run: yarn run preview

Scripts

• dev: Starts the Vite development server.
• build: Builds the project for production using Vite.
• preview: Previews the production build using Vite.
• format: Formats the code using Prettier.
• type-check: Checks TypeScript types.
• lint: Lints the code using ESLint.
• prepare: Prepares the project by running Husky.
• test: Runs Jest tests with coverage.
• test:watch: Runs Jest tests in watch mode with coverage.
• test:update: Updates Jest snapshots.
• test:clear: Clears Jest cache.
• lint-staged: Runs linting on staged git files before committing.
• update-snapshots: Updates Jest snapshots for changed .tsx files before committing.

Dependencies

• lodash: ^4.17.21
• react: ^18.3.1
• react-confetti: ^6.1.0
• react-dom: ^18.3.1
• react-use: ^17.5.0
• date-fns: "^3.6.0",
• date-fns-tz: "^3.1.3",

Dev Dependencies

• @commitlint/cli: ^19.3.0
• @commitlint/config-conventional: ^19.2.2
• @swc/core: ^1.6.3
• @swc/jest: ^0.2.36
• @testing-library/dom: ^10.1.0
• @testing-library/jest-dom: ^6.4.6
• @testing-library/react: ^16.0.0
• @testing-library/user-event: ^14.5.2
• @types/jest: ^29.5.12
• @types/node: ^20.14.5
• @typescript-eslint/eslint-plugin: ^6.0.0
• @typescript-eslint/parser: ^6.0.0
• @vitejs/plugin-react: ^4.2.1
• autoprefixer: ^10.4.19
• camelcase: ^6.0.0
• cypress: ^13.12.0
• daisyui: ^4.12.8
• eslint: ^8.2.0
• eslint-config-airbnb-typescript: ^16.0.0
• eslint-config-node: ^4.1.0
• eslint-config-prettier: ^8.0.0
• eslint-import-resolver-typescript: ^3.6.1
• eslint-plugin-deprecation: ^2.0.0
• eslint-plugin-import: ^2.25.2
• eslint-plugin-jest-dom: ^5.4.0
• eslint-plugin-jsx-a11y: ^6.7.0
• eslint-plugin-node: ^11.1.0
• eslint-plugin-package-json: ^0.12.0
• eslint-plugin-prettier: ^5.1.3
• eslint-plugin-react: ^7.28.0
• eslint-plugin-react-hooks: ^4.6.0
• eslint-plugin-testing-library: ^6.2.2
• husky: ^9.0.11
• identity-obj-proxy: ^3.0.0
• jest: ^29.7.0
• jest-environment-jsdom: ^29.7.0
• jsonc-eslint-parser: ^2.0.0
• lint-staged: ^15.2.7
• nanoid: ^5.0.7
• postcss: ^8.4.38
• prettier: ^3.2.5
• prettier-plugin-tailwindcss: ^0.6.5
• tailwindcss: ^3.4.4
• ts-jest: ^29.1.5
• ts-node: ^10.9.2
• typescript: ^5.4.5
• vite: ^5.2.11

Author

Oleksii Suprun
Email: [email protected]

License

This project is licensed under the MIT License. See the LICENSE file for details.