This project is a web game created using React, Vite, TypeScript and consuming the public API of GitHub. The game displays all the data of two randomly selected repositories and the user must choose which one has more stars. The design is made with CSS3 modules and custom hooks, and a dedicated client is used to utilize the GitHub API.
- Functional Components in React
- Project Organization using React and TypeScript
- Responsive and Modern Design using CSS3 and CSS modules
- Flexbox and Layout Fundamentals
- Usage of CSS Variables for Theme Creation
- Custom Hooks Creation
- Commits using Conventional Commits
- Typing using TypeScript
- Creation of Utilities
This project uses the following tools:
- React and ReactDOM for building the UI
- TypeScript for typing and safer development
- Vite for fast development and production builds
- @octokit/core and axios for communication with the GitHub API
- react-icons for UI icons
To use this project, you need to follow these steps:
- Clone the repository:
git clone https://github.com/kevinCubas/repo-wars.git - Install the dependencies:
npm install- Run the application:
npm run devNote: This project uses Vite to run locally. Make sure to run the project using npm run dev instead of npm start.
To contribute to this project, please follow these guidelines:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name - Make your changes and commit them using Conventional Commits
- Push to the branch:
git push origin feature/your-feature-name - Submit a pull request
This project is licensed under the MIT License - see the LICENSE.md file for details.
This project was created by kevinCubas.