46 lines
958 B
Markdown
46 lines
958 B
Markdown
# Minesweeper Frontend
|
|
|
|
### Stack used:
|
|
|
|
- Javascript
|
|
- [ReactJS][stack/reactjs]
|
|
|
|
OpenAPI 3 documentation: [https://apidoc.mines.makecodes.dev/][url/apidoc]
|
|
Game frontend: [https://mines.makecodes.dev/][url/the-game]
|
|
Backend github repo: [https://github.com/imakecodes/minesweeper-backend][github/backend]
|
|
|
|
# Next desired steps
|
|
|
|
- Create unit tests
|
|
- Create e2e tests
|
|
- Design the authentication page
|
|
- Create the scoreboard
|
|
|
|
# Running locally
|
|
|
|
### Clone the repository
|
|
|
|
```bash
|
|
git clone git@github.com:imakecodes/minesweeper-frontend.git
|
|
cd minesweeper-frontend
|
|
```
|
|
|
|
### Install dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Run the application
|
|
|
|
```bash
|
|
npm run start
|
|
```
|
|
|
|
The application will be available at [http://localhost:3000](http://localhost:3000)
|
|
|
|
[stack/reactjs]: https://reactjs.org/
|
|
[url/apidoc]: https://apidoc.mines.makecodes.dev/
|
|
[url/the-game]: https://mines.makecodes.dev/
|
|
[github/backend]: https://github.com/imakecodes/minesweeper-backend
|