Skip to content

PhilipK/CardboardButler

Repository files navigation

Cardboard Butler

Cardboard Butler Logo

Cardboard Butler is an open-source web page, that helps you decide the next boardgame to play. You can view the live version here: Cardboard Butler

Why

As boardgame collections grow, it gets more and more difficult decicde on what to play. This will help you decide.

Installation

Make sure you have Node.js installed and can run npm.

To install run

npm install

or if you have yarn installed

yarn

Developing

To start the development server

yarn start

The server will now be listening at: http://localhost:8080

Testing

It is important to make sure all unit tests work when developing, and also to make new ones for your features. To start testing run:

yarn test

Building for production

To build run:

yarn build

This will create a production ready build in the dist folder.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Support BGG

All game data is from BoardGameGeek. If you like Cardboard Butler, you can help by supporting BGG here

Build Status

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published