https://github.com/larsgw/crappycards
https://github.com/larsgw/crappycards
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/larsgw/crappycards
- Owner: larsgw
- License: other
- Created: 2018-04-03T20:44:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-18T21:04:39.000Z (over 5 years ago)
- Last Synced: 2025-01-06T02:42:28.106Z (4 months ago)
- Language: CoffeeScript
- Size: 113 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
#  Crappy Cards
A [Happening](https://happening.im) plugin based on [Cards Against Humanity](https://cardsagainsthumanity.com/) (see [LICENSE](https://github.com/larsgw/CrappyCards/blob/master/LICENSE.md)).
> I don't agree with all the content in Cards Against Humanity. Because of that, I'm currently working on labeling the cards, to give the user the option to filter out certain topics. This option will be on by default.
## Install
There is currently no production developer console instance for Crappy Cards. For now, you can deploy it yourself by following these steps (adapted from the [Happening example code](https://github.com/Happening/Example)).
> On Linux/Mac, use your Bash-compatible shell. On Windows, we recommend the Git shell that comes with [Git](http://git-scm.com/download/win).
>
> 1. Clone the code: `git clone https://github.com/larsgw/CrappyCards.git; cd CrappyCards`.
> 2. Run `node updateCards.js` to load card data
> 3. Create a **Developer console app** via https://happening.im/store/106 and clicking "Start!".
> 4. Create a directory with a __deploy key__ file: `mkdir .keys/; echo {deployKey} > .keys/foo`.
> 5. Deploy your app using `./deploy foo` or `npm run deploy -- foo`. It should instantly update in your browser / app.
## Contribute
### Bugs & other issues
Report at [GitHub Issues](https://github.com/larsgw/issues).
### Test
Currently, there are no other tests than creating a test environment and running it yourself. On how to deploy the app, see the *Install* guide above.
### Update cards
1. Clone the code: `git clone https://github.com/larsgw/CrappyCards.git`.
2. Install dev packages: `npm install`
3. Change the version in `updateCards.js` (at `cardsUrl`). Try to make sure that the card and pack IDs match up.
4. Run script: `node updateCards.js`
### Classify cards
Help with classifying cards would be very welcome, but is currently not viable.