Web Board Games

List your games, find games to play with others.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Finding out what games you have and which games you can play with others should be fast and easy. At the moment, however, the process takes a lot of communication and manual effort.

Thus, the aptly named 'web board games' has been written, it's main features include:

• Fast and minimal, pages are <20kb in size.
• Supports any game in the "Board Game Geek" list.
• Can filter games by player count, playtime, etc.

Built With

• Node
• Redis
• MongoDB

Getting Started

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

Prerequisites

• node (tested on v12+)
• npm

npm install npm@latest -g

• mongo

# either from https://www.mongodb.com/ or with Docker:
docker volume create --name=mongodata
docker run -p 27017:27017 --name mongo -v mongodata:/data/db -d mongo

• redis

# either from https://redis.io/ or with Docker:
docker volume create --name=redisdata
docker run -p 6379:6379 --name redis -v redisdata:/data -d redis redis-server --appendonly yes

• web-authentication-provider
• web-authentication-token-service

Installation

1. Clone the repo

git clone https://github.com/femto-apps/web-board-games

2. Install NPM packages

npm install

3. Copy config.default.hjson to config.hjson

cp config.default.hjson config.hjson

4. Update the configuration to your liking, specifically you must change minio.accessKey, minio.secretKey, session.secret and authenticationProvider.consumerId

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. 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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Alexander Craggs - bg@femto.host

Project Link: https://github.com/femto-apps/web-board-games

Acknowledgements

• Img Shields
• Choose an Open Source License