/minesweeper-ts

Mine Sweeper - Typescript

Primary LanguageTypeScriptMIT LicenseMIT

Mine Sweeper - Typescript



Mine Sweeper in Typescript ! Fully functionnal.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need NodeJS installed on your system to continue.

Installing

Installing to work on the code is is just as simple as a few commands

git clone https://github.com/ekarious/minesweeper-ts.git
cd minesweeper-ts
npm install
npm start

or if you just want to play it

npm run build

and use the files in the dist folder.

Running the tests

Adding unit tests will be the next big step of this project.

Deployment

To just play the game, use those commands

git clone https://github.com/ekarious/minesweeper-ts.git
cd minesweeper-ts
npm install
npm run build

Note the npm run build there. It will add a new directory in the root project folder called dist with production ready files in it.

Use those to play the game.

Uses

This project use only HTML, CSS and pure Javascript. The only external library used is moment to make working with dates easier.

Contributing

Coming Soon

Versioning

I'm using SemVer for versioning.
For the versions available, see the releases on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details