Skip to content

Latest commit

 

History

History
180 lines (134 loc) · 6.59 KB

README.md

File metadata and controls

180 lines (134 loc) · 6.59 KB

Tic tac toe

Made with love License


If you want to read this readme in Spanish

📜 About

Welcome to my Tic Tac Toe web app! I’ve created this classic game to showcase my skills and problem-solving abilities.

If you’re playing against a friend, get ready to strategize, make your moves, and claim victory in this timeless battle! 🎮✨

(Go Back To Top 🔝)

👀 Preview

In a iPhone SE (375x667)

Project screenshot with a resolution of 375x667

(Go Back To Top 🔝)

💬 Features

  • Favicon Support: Support for a wide range of favicon sizes has been added, ensuring that the site’s icon displays correctly on all devices and platforms.
  • Open Graph and Twitter Tags: Open Graph and Twitter meta tags have been included, which optimize the preview of the website on social platforms like Facebook and Twitter.
  • Cross-Browser Compatibility: The web page uses the X-UA-Compatible meta tag, which helps ensure compatibility with multiple browsers, especially older versions of Internet Explorer.
  • Algorithm for Winning: The algorithm to determine if a player has won is essential for the game’s functionality. By checking winning combinations (through an algorithm), we ensure that the game correctly declares the winner.
  • Alogrithm for Ties: The tie algorithm prevents the game from continuing indefinitely. It checks if all squares are filled and there is no winner, declaring a tie.
  • Confetti Animation on Win: Adding confetti at the end of the game creates a visually pleasing and exciting experience. It adds a fun and festive touch to the game.

(Go Back To Top 🔝)

🧰 Stack

  • React - A JavaScript library for building interactive user interfaces.
  • Vite - A fast and lightweight development environment for modern web applications.
  • ESLint - An open-source tool that helps you find and fix problems in your JavaScript code.

(Go Back To Top 🔝)

🚀 Getting Starter

  1. Fork or clone this repository
git clone git@github.com:joserafael0160/tic-tac-toe.git
  1. Install the dependencies:
  • I used bun to install and manage the dependencies.
# Install bun for MacOS, WSL & Linux:
curl -fsSL https://bun.sh/install | bash

# Install bun for Windows:
powershell -c "iwr bun.sh/install.ps1|iex"

# Install with bun:
bun install
  • or you can use pnpm:
# Install pnpm globally if you don't have it:
npm install -g pnpm

# Install dependencies:
pnpm install
  1. Run the development server:
# Run with bun:
bun run dev

# Run with pnpm:
pnpm run dev

(Go Back To Top 🔝)

🧞 Commands

Command Action
⚙️ dev Starts the local development server.
⚙️ build Builds the production version to ./dist/.
⚙️ lint Runs ESLint to find issues in your JavaScript code.
⚙️ preview Previews the local build.
⚙️ predeploy Generates the production version before deploying.
⚙️ deploy Deploys the site to GitHub Pages from the dist folder.

(Go Back To Top 🔝)

🤝 Contributions

Contributions are always welcome! Whether you’re reporting bugs, requesting new features, or improving existing functionalities, your help is greatly appreciated.

If you have any suggestions that could improve the project, please make a fork of the repository and create a pull request. You can also simply open an issue with the “enhancement” label.

Here is a quick guide:

  1. Make a fork of the Project
  2. Clone your fork (git clone <URL of the fork>)
  3. Add the original repository as remote (git remote add upstream <URL of the original repository>)
  4. Create your Feature Branch (git switch -c feature/NewFeature)
  5. Make your Changes (git commit -m 'Add: some NewFeature')
  6. Push to the Branch (git push origin feature/NewFeature)
  7. Open a pull request

(Go Back To Top 🔝)

🔑 License

MIT

(Go Back To Top 🔝)

🙏 Support

Don't forget to leave a star ⭐️

(Go Back To Top 🔝)


✌️

A project created by @joserafael0160