r3trofitted / ye-sepulchre-inn

Ye Sepulchre Inn – a web adaptation of the board game _La Taverne de la Cypte_

Ye Sepulchre Inn

Ye Sepulchre Inn is the web adaptation of the board game La Taverne de la Crypte.

It is an easy-to-grasp and fast-to-play game for 3 to 5 (or more!) players that recreates a fantasy tavern brawl. Colorful characters throw punches, pints, chairs and occasionally waitresses at each other, hoping to be the last person standing when the town militia arrives.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Ye Sepulchre Inn is a basic Rails 7 app; everything you need is covered in the excellent Rails guides.

Installing

Rails comes with a simple bin/setup script that will install everything for you – just run it. Should you want to do everything yourself, all you have to do is install the dependencies and set up the database.

bundle install
bin/rails db:prepare

I personally find the testing fixtures useful in development. Loading them will get you up and running faster.

bin/rails db:fixtures:load

Now you can launch the server and invite your friends to play!

bin/rails server

Running the tests

Once again, pretty standard Rails stuff.

I really like the testing pyramid, and I really, really like to focus exclusively on its top and bottom, as do people smarter than me.

System tests

The top of the pyramid. Since Rails 5.1, they are easy to make and well explained.

bin/rais test:system

Unit tests

The bottom of the pyramid. For this project, they are mostly synonymous with model testing.

bin/rails test

Everything at once

bin/rails test:all

Deployment

[TODO]

Built With

• Ruby On Rails - Duh

Contributing

[TODO]

Acknowledgments

• PurpleBooth for her cool README template