kido-k / mugensweeper

💣 MugenSweeper is unlimited Minesweeper.

MugenSweeper

Development

Installation

Install dependencies.

$ npm install # Or yarn

Usage

Develop MugenSweeper.

# all
$ npm run dev # Or yarn dev

# API server only
$ npm run dev:api # Or yarn dev:api

# Client only
$ npm run dev:client # Or yarn dev:client

Testing scripts.

# Manual
$ npm test # Or yarn test

# Automatic
$ npm run test:watch # Or yarn test:watch

# Report test coverage
$ npm run test:coverage # Or yarn test:coverage

Database

MugenSweeper depends on MongoDB.
Please prepare MongoDB for development.

• Download
  MongoDB Download Center
• Cloud
  MongoDB Cloud Database Solutions

Environment Variables

MugenSweeper is using dotenv.
To set environment variables, create an .env file.

MongoDB

Default: mongodb://localhost:27017/mugensweeper

# Example (Using MongoDB Atlas)
MONGO_URI=mongodb://<username>:<password>@cluster0-shard-00-00-iuxvg.mongodb.net:27017...