Skip to content

P-Jeremy/zoOthello-MERN-project

Repository files navigation

Welcome to zoOthello 👋

Version Documentation Maintenance License: ISC Twitter: _jeremy_p_

A react(no CRA)/Express/mongoDB Othello game

Important

For the game to work, you'll need a MongoDB Atlas data base.

Store your atlas config in a '.env' file in the root folder.

Your '.env' file should contain an environemnt variable that looks like this :

MONGO_CONFIG_URL='mongodb+srv://(PUTYOURUSERNAMEHERE):(PUTYOURPASSWORDHERE)@cluster0-ctrcz.mongodb.net/test?retryWrites=true&w=majority'

Prerequisites

  • npm 6.14.8
  • node 14.14.0
  • docker

Install

npm install

Launch client

npm run webpack

Launch server

npm run server

Launch server & client

npm run dev

Launch Docker for server testing

docker-compose up -d

Run client tests

npm run test:client

Run server tests with coverage

npm run test:server

Run linter

npm run lint

Special thanks

@kjirou for his Reversi package (https://www.npmjs.com/package/reversi)

Author

👤 Jérémy Pluquet

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Jérémy Pluquet.
This project is ISC licensed.


This README was generated with ❤️ by readme-md-generator