Welcome to the Cricket Card Game, a multiplayer game where you can enjoy cricket stats, compare players, and compete with friends!
To get started with the Cricket Card Game, follow these steps:
Make sure you have Node.js and npm installed on your machine.
Clone the repository and install dependencies:
git clone <repository-url>
cd cricket-card-game
npm installStart the development server:
npm run devThis command starts the Vite development server with Hot Module Replacement (HMR) enabled.
To build the project for production:
npm run buildThis creates an optimized production build of your project in the dist directory.
The project uses ESLint for linting with TypeScript and React support. Here's how ESLint is configured:
- ESLint setup includes rules for TypeScript (
@typescript-eslint), React (eslint-plugin-react), and React Hooks (eslint-plugin-react-hooks). - Type-aware lint rules are enabled by configuring
parserOptionsin.eslintrc.js.
The project structure follows a typical React + TypeScript setup with Vite:
cricket-card-game/
├── public/ # Static assets
├── src/ # React components and application logic
│ ├── components/ # Reusable React components
│ ├── pages/ # React components for different pages/views
│ ├── App.tsx # Main application component
│ └── index.tsx # Entry point
├── .eslintrc.js # ESLint configuration
├── tsconfig.json # TypeScript configuration
├── vite.config.ts # Vite configuration
└── README.md # This file
Contributions are welcome! If you have any ideas or improvements, feel free to submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
Adjust <repository-url> with your actual repository URL. This structure and content will help users understand how to set up, develop, and contribute to your Cricket Card Game project using React, TypeScript, and Vite with ESLint for code quality assurance.