NO-NAME

What is no-name

No-name is a project centered around the popular card game Cards Against Humanity. The project intend to make it possible to play Cards Against Humanity online with friends.

Key features

Playing Cards Against Humanity online
Easy to get going
Easy to invite friends

Features coming up

Creating your own card deck

Running

This project has a Docker image that can be used to run the app in production environment. The app use postgres as database and redis for cache and session storage. Bellow is an for a docker-compose file to run the app.

networks:
  local:
    driver: bridge

services:
  no-name:
    container_name: no-name
    image: ghcr.io/albin-rohde/no-name_app:latest
    ports:
      - 5000:5000
    restart: unless-stopped
    networks:
      - local
    depends_on:
      - pg_db
      - redis
    environment:
      - COOKIE_SECRET="some-secret"
      - CLIENT_URL="https://example.com"
      - POSTGRES_HOST=pg_db
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password

  pg_db:
    container_name: pg_db
    image: postgres
    restart: unless-stopped
    networks:
      - local
    ports:
      - 5432:5432
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password

  redis:
    container_name: redis
    image: "redis:alpine"
    command: redis-server
    networks:
      - local
    ports:
      - 6379:6379
    environment:
      - REDIS_REPLICATION_MODE=master

Environment - no-name

Environment	Description	Default
`PORT`	Defines the port the app will run on.	`5000`
`COOKIE_SECRET`	A random string used to sign session cookie.	Required
`CLIENT URL`	Full path where the app will be hosted.	`http://localhost:5000`
`POSTGRES_HOST`	The app expect postgres to be running on this host	`localhost`
`POSTGRES_PORT`	The app expect postgres to be running on this port	`5432`
`POSTGRES_USER`	The app will use this user to connect to postgres	`user`
`POSTGRES_PASSWORD`	The app will use this password to connect to postgres	Required
`POSTGRES_DB`	The app will use this db when connection to postgres	`no_name_db`
`DEBUG`	Set this to `1` to get debug logs from app	`0`

Environment - postgres

Environment	Description	Default
`POSTGRES_PORT`	Defines the port postgres will start on	`5432`
`POSTGRES_USER`	Defines the root user for postgres	`user`
`POSTGRES_PASSWORD`	Defines the password for the root user	Required

Contributing to this project

To contribute to this project follow the instructing in Development.md to get started.

How to play

Begin by signing up or signing in. When logged in one is greeted by the "dashboard", from here the player can create a game with desired settings. When the game is created, invite some friends and hit start.

A black card consisting of a sentence with a "blank" will appear, visible to all players. The players will receive a couple of "white cards" consisting of word(s) or a short sentences. The goal now is for the player to match a white card on their hand with the black card; creating the funniest sentence.

One player each round will be assigned to the role as "card wizz". This player will not get to play any card. This player will instead be tasked of voting for the funniest card.

Once all players has played their cards, the card wizz will get to flip one card at a time, reading them out loud. When the card wizz has read all cards, he/she should decide on the funniest combination.

The winner is awarded 1 point and the gamw will continue to the next round, a new card wizz will be assigned for the new round.

Albin-Rohde / no-name

readme