cardjizzerapp / cardjizzerbackend

:zap: Backend for the CardJizzerApp

CardJizzers' Backend

The backend of CardJizzer.

What is this | Motivation | Installation | Contributing

---

What is this?

What Is Cards Against Humanity?

The game, with its game rules was invented by a Kickstarter campaign in the year 2011. It is a turn based card game for the most parts played in real life.

Every player receives a specific amount of white cards that are used to fill placeholders provided in the black card.

At the end of the round, when all players played a card, the card czar (in our case the CardJizzer) picks the most hilarious card.

On the start of a new round every player gets the amount of whitecards he laid in the last round.

Although there are already clones out there we want to build a open source forgery for the App- and PlayStore.

We decided to bring fresh air in this game and created this hybrid app which allows anybody to play this beautiful game anywhere and anytime.

What is this repo about?

This repository is the backend part of the app. It will be deployed to our servers after your push.

Please follow this link for the frontend part of this project.

Motivation

Why are we doing this? We want the future of games to be more transparent and modifiable for any developer.

Installation

Environment variables

The following code segment shows the environment variables used. (See .env for a possible updated version).

NODE_ENV=dev

REDIS_HOST=localhost
REDIS_PORT=6379

MONGO_DATABASE=cardjizzer-testdb
MONGO_HOST=localhost
MONGO_PORT=27017

SENTRYDSN=INSERTSENTRYDSNHERE

PORT=8100

GOOGLE_OAUTH_CLIENT_ID=CLIENT_ID

Docker

We recommend running this service as a docker container.

Quickstart with Docker-compose

We need two databases: Redis and Mongo. One is used for temporary caching and the other for permanent storage such as users with their GoogleId and email.

Consequently we suggest using Docker-compose containing all those services named above.

version: '3'

services:
    backend:
        image: docker.pkg.github.com/cardjizzerapp/cardjizzerbackend/server
        ports:
            - "8100:8100"
        environment:
            - MONGO_HOST=mongo
            - REDIS_HOST=redis
            - PORT=8100
        links:
            - redis
            - mongo
    redis:
        image: redis
    mongo:
        image: mongo

Contributing

Getting a better understanding of the project will be essential before even thinking about contributing. Thus the commands you need in order to setup your environment.

$ npm i && npm run setup
# Checking if build succeeds
$ npm run test
# Building
$ npm run build
# Development
$ npm run dev

Resolved your issue? Contribute!

Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

cardjizzerbackend's Issues

Add documentation on how to work with this repository in readme

The current README looks quite empty concerning the "how to start contributing" part. Add some basic documentation for every developer which wants to add something to this project. Add commands for testing, building and linting the projects' code.

Fix tests

The current build is failing due to not working tests. The code has been changed to work with callbacks. Not all commands are working with this.

Move res/logo.svg to assets and change url of the README-logo to the assets repository

The logo of the README.md file is currently in each repository that uses this logo.

Due to multiple repositories containg our logo I would suggest moving this svg file to the assets repo and reference it in this and every other readme.md file

Unit tests for Google oauth

Current situation

There is a command (setUsername) used for creating a link between the websocket and the user that wants to log in. Since this command is now deprecated and will be replaced by the login command there is now a need for using real Google oauth data in unit tests (or maybe not. Have a look at solutions).

Solutions

Multiple solutions are conceivable.

• Create and insert a dummy user after the database was created and use those credentials.
• Use real Google oauth data

Unfortunately Google doesn't provide such dummy data. The only possible way of implementing the second approach would be real users that need to provide a refresh token every 60 minutes.

Conclusion

Considering only the effort put in the first approach it would be the better one.
BUT
This will result in a lower test coverage and the oauth mechanism can then be broken easily.

Allow only the lobby owner to start the game

Currently every player can start a game they've joined. Restrict the start ability only to the owner.

Re-implement ssl

The current server (http-package) does not support SSL encryption. We should introduce the https package.

Files to change: app.js