janpc/minesweeper

Javascript Minesweeper | Paly

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This is jus a simple minesweeper I've made to practice. It just works in desktop mode.

Built With

• Html
• Css
• Sass
• Javascript
• JQuery
• Npm
• Webpack

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You will need npm to run this program.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/janpc/Minesweeper.git

2. Install NPM packages

   npm install

3. Build the app:

   npm run build

   or if you want it in a local server:

   npm run start

4. Run the index.html generated in the dist folder

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Jan Puig - @janpc - [email protected]

Project Link: https://github.com/janpc/Minesweeper

Acknowledgements

• JQuery
• Sass
• Font Awesome
• Google fonts
• Best-README-Template