Skip to content

AdeebAli/tic-tac-toe

Repository files navigation

Tic Tac Toe for the Web ❌⭕

codecov CI Pipeline

The Classic Two Player Game, in the browser!

The frontend web application for playing tic tac toe on the browser.

Made with React, Eslint, and Vite/Vitest.

Requirements

  • NodeJS 18+

Getting Started

First things first...

    npm i # installs dependencies

To run the application with a live dev server that supports hot reloading, run

    npm run dev

To build and run a production ready version of the app, run

    npm run build

Testing

To run the full test suite,

    npm test

To Test with coverage, you can use

    npm test -- --coverage

Linting / Code Style

This project uses the default recommended ruleset for eslint to enforce code style and syntax errors. Linting is run with the lint command as well as the general npm test command.

To run the linter and check for code style errors,

    npm run lint

Oh no! We have a bunch of linting errors. That's totally fixable! You just need to run

    npm run lint:fix

Running with Docker

This application can be run with Docker using the supplied Dockerfile to build the image. Your machine must have Docker installed in order to perform the following steps. Download instructions can be found on the Official Docker Website

Building the Image

change directory to the root of the repository, then

docker build -t <username>/tic-tac-toe .

Running the Image

docker run -p <public_port>:8080 -d <username>/tic-tac-toe

Made With ❤️ Using

  • React - Web Application Framework
  • Vite - Build tool
  • Vitest - Unit Testing Framework
  • Eslint & Prettier - Code Style and Formatting

About

tic tac toe application for the web.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published