Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andreynav/tic-tac-toe

Tic-tac-toe simple game | React
https://github.com/andreynav/tic-tac-toe

react styled-components typescript

Last synced: 3 days ago
JSON representation

Tic-tac-toe simple game | React

Awesome Lists containing this project

README

        

![GitHub repo size](https://img.shields.io/github/repo-size/andreynav/tic-tac-toe?style=for-the-badge)
![GitHub deployments](https://img.shields.io/github/deployments/andreynav/tic-tac-toe/Production%20%E2%80%93%20tic-tac-toe-andyn?label=vercel%20deployment&style=for-the-badge)
![Website](https://img.shields.io/website?label=tic%20tac%20toe&style=for-the-badge&url=https%3A%2F%2Ftic-tac-toe-andyn.vercel.app%2F)

# General Notes

The current project is a project of simple tic-tac-toe game executed due to the React and Styled components.

## Demo

You can open and use the app by [tic-tac-toe app link](https://tic-tac-toe-andyn.vercel.app/).

## Project structure

The project has multilayer structure:

- `public` - used to keep static content for builds
- `assets` - used to keep static content
- `components` - used to keep react components
- `hooks` - used to keep hooks
- `styles` - used to keep styles
- `utils` - used to keep utils for helping

## Dependencies

The project has the next dependencies in the [package.json](package.json) file.

![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/tic-tac-toe/react?style=for-the-badge)
![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/andreynav/tic-tac-toe/styled-components?style=for-the-badge)

## Installation

1. Clone project to your PC by the following command:

```console
git clone https://github.com/andreynav/tic-tac-toe.git
```

2. Open the root directory and enter the following command:

```console
yarn
```

3. In the root directory create `.env` file and add inside it a row `PORT=3003` (or any desired port).

## Running project

To run project, open the root directory and enter the following command:

```console
yarn start
```

The command runs the app in the development mode.
Open [http://localhost:3003](http://localhost:3003) to view it in your browser.

## License

The project is open source software provided under the [Apache License 2.0](LICENSE.md).