📚 Updated README

This commit is contained in:
2024-02-19 09:49:01 +01:00
parent 2fea366313
commit c74c44c521
4 changed files with 68 additions and 2 deletions
+68 -2
View File
@@ -1,6 +1,67 @@
# Minesweeper <div style="display: flex; align-items: center;gap: 20px;">
<img src="./assets/logo_circle.png" alt="logo" width="100">
<h1>Minesweeper</h1>
</div>
## Docker ## Table of content
- [Description](#description)
- [Techno used](#techno-used)
- [Installation](#installation)
- [Local](#local)
- [Docker](#docker)
- [Credits](#credits)
## Description
Minesweeper is a game where the player has to clear a minefield without detonating any mine. The game is won when all the cells without a mine are revealed. The game is lost when a mine is revealed.
<div style="display: flex; align-items: flex-start; gap: 10px">
<img src="./assets/game.png" alt="game" width="45%" height="auto" />
<img src="./assets/leaderboard.png" alt="game" width="45%" height="auto" />
</div>
## Techno used
<ul style="columns: 2">
<li>React</li>
<li>Recoil</li>
<li>TypeScript</li>
<li>SCSS</li>
<li>Docker</li>
</ul>
## Installation
### Local
- Clone the repository
```bash
git clone https://www.github.com/KeunotorCagoule/minesweeper.git
```
- Install the dependencies
```bash
npm install
```
- Run the server as _development_
```bash
npm start
```
- Run the server as _production_
```bash
npm run build
npm i -g serve
serve build
```
### Docker
- Build the image - Build the image
@@ -13,3 +74,8 @@
```bash ```bash
docker run --name minesweeper -dp 3000:3000 minesweeper docker run --name minesweeper -dp 3000:3000 minesweeper
``` ```
# Credits
- [KeunotorCagoule](https://www.github.com/KeunotorCagoule)
- [UnEpicier](https://www.github.com/UnEpicier)
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 161 KiB