Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thrillberg/imperial
Imperial is a fun board game.
https://github.com/thrillberg/imperial
board-game game imperial
Last synced: 28 days ago
JSON representation
Imperial is a fun board game.
- Host: GitHub
- URL: https://github.com/thrillberg/imperial
- Owner: Thrillberg
- Created: 2020-05-20T13:05:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T06:30:10.000Z (about 1 month ago)
- Last Synced: 2024-11-26T11:26:19.291Z (about 1 month ago)
- Topics: board-game, game, imperial
- Language: JavaScript
- Homepage:
- Size: 15 MB
- Stars: 17
- Watchers: 7
- Forks: 6
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](code_of_conduct.md)
# Imperial
This is an implementation of the board game, [Imperial]().
It can be played in production at [playimperial.club](https://playimperial.club).
_Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms._
## Local development setup
Imperial uses Ruby version 3.2.2, Redis (> 4.0), PostgreSQL, and NodeJS.
To run Imperial on your local machine, please follow these instructions:
1. Clone the repo:
```
git clone https://github.com/Thrillberg/imperial.git
```
2. Change directory into the `imperial` directory:
```
cd imperial
```
3. Begin the PostgreSQL service:
- If installed through `brew`
```
brew services start postgresql
```
- If installed through `apt`
```
sudo service postgresql start
```
4. Start a Redis server:
- If installed through `brew`,
```
brew services start redis
```
- If installed through `apt`, in a separate terminal
```
redis-server
```
5. Run the Rails setup command:
```
bin/setup
```
- If you get the error `PG::InsufficientPrivilege: ERROR: permission denied to create extension "pgcrypto"` run this command:
```
sudo su postgres -c "psql rails_server_development -c 'CREATE EXTENSION pgcrypto;'"
```
- If you get the error `‘ruby\r’: No such file or directory`, make sure your editor's line-endings are set to `LF` instead of `CRLF`.
6. Run the npm install command:
```
npm install
```
7. In one terminal window, run webpack:
```
bin/webpack --watch
```
8. Keep webpack running and in a separate terminal window, run the Rails server:
```
rails s
```
9. You can now view the app at
```
localhost:3000/
```
If any of the above instructions did not work for you, please do not hesitate to [open an issue](https://github.com/Thrillberg/imperial/issues/new).
## Running tests
To run JS tests, run the following command from the project root:
```
npm test
```
To run Ruby RSpec tests, run the following command from the project root:
```
rspec
```
This project also uses [Cypress](https://www.cypress.io/) for feature tests. **These tests have not been maintained, however.** To
run these tests, run the following command from the project root:
```
bin/webpack
./test_server
```
And in another terminal:
```
npm run cypress
```
## Local debugging
Production games will often present situations that are hard to reproduce locally and therefore get challening to debug. Therefore, we have implemented the ability to **export** and **import** games.
### Exporting a game
Visit `/exports/[game_id]` and a `JSON` file will be downloaded to your computer. This file contains the game log and can be used when importing a game.
### Importing a game
Visit `http://localhost:3000/import_game` and paste the contents of the downloaded `JSON` in the box and click `Import game`. This will reconstruct the game locally in your database and let you play around with it and, hopefully, improve debugging.