This is the server side component to the deck building card game of Accession. This application is one half of the Accession game, and is required to generate games and manage game state. The general principles of Accession are...

• Deck building card games start with each player having the same collection of cards, who then buy cards from a central pool and build a deck to gain victory points and win the game. Accession is a base implementation of this style of game, with plans for expansion in the future. The full set of rules can be found at the bottom of this documentation.

A live version of this application can be accessed via https://accession-game-server.herokuapp.com/ using our endpoints below! If you would like to run your own local version, follow the instructions that follow.

• Brew Package Manager
• Git
• PostgreSQL
• Ruby Version: 2.4.1
• Rails Version: 5.2.3

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

brew install rbenv
rbenv init

brew install postgresql
brew services start postgresql
psql postgres

• All below commands are to be run in your terminal or command line of choice.

To get the the Accession Server application up and running on your local machine, start by getting the source code from this GitHub repository:

git clone [email protected]:BrennanAyers/tsdbcg.git (for SSH)
cd tsdbcg

The Accession Server uses the bundler library to manage dependencies. This process will take some time to install all of the correct versions of the libraries we use. After cloning down the repo with the above commands:

bundler install

After Bundler installs all required packages, run in the the Accession Server directory:

rails db:create
rails db:migrate
rails db:seed

Now that our application files are sorted, and the database has pertinent information inside of it, we can start the application:

rails server

This will begin the server on your localhost:, generally on Port 3000. Now that that you have the game server up and running, you can interact with it through the Endpoints below, or install our UI application from here!

• A POST request used to start a new Game with a single Player. The Game does not start, as it does not have the required number of Players, but others will now be able to join using the Game ID.
• Example Request:

POST api/v1/games
BODY: {
  "newPlayer": {
    "name": "Ted"
    }
  }

• Example Response:

Status: 201
BODY: {
  "playerName": "Ted",
  "playerId": 1,
  "gameId": 1
}

• A POST request with a Body containing a Player name, and the Game ID of the Game the Player would like to join. Upon all Players required joining a Game, all GameCards for both the board, and all Players will be created and assigned to their respective areas. Example Request:

POST /api/v1/join_game
BODY: {
  "playerName": "George",
  "gameId": 1
}

Example Response:

Status: 200
BODY: {
  "playerName": "George",
  "playerId": 2,
  "gameId": 1,
  "gameStatus": "Game Started"
}

• A GET request used to query the current Game state. This endpoint returns all publicly available information, such as all Action Cards, purchasable Money and Victory Cards, the Player turn order, Players current hand sizes, current most recent discarded Card, and all information to render the cards themselves.
• Example Request:

GET api/v1/game_state/1

• Example Response:

Status: 200
BODY: {
  "tableDeck": [
    {
      "name": "Gold",
      "category": ["Money"],
      "cost": 6,
      "victoryPoints": 0,
      "spendingPower": 3,
      "buyingPower": 0,
      "actionsProvided": 3,
      "cardsToDraw": 0,
      "image": "./gold.jpg",
      "desc": "",
      "tags": [],
      "countAvailable": 5,
      "id_list": [ 1011, 1012, 1013, 1014, 1015 ]
    },
    {
      "name": "Estate",
      "category": ["Victory"],
      "cost": 2,
      "victoryPoints": 1,
      "spendingPower": 0,
      "buyingPower": 0,
      "actionsProvided": 0,
      "cardsToDraw": 0,
      "image": "./estate.jpg",
      "desc": "",
      "tags": [],
      "countAvailable": 8,
      "id_list": [ 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048]
    },
    ...
  ],
  "playerOrder": [ "Player_1_Name", "Player_2_Name" ],
  "playerInfo": {
    "Player_1_Name": {
      "deckSize": 10,
      "topCardDiscard": 0,
      "handSize": 5
    },
    "Player_2_Name": {
      "deckSize": 10,
      "topCardDiscard": 0,
      "handSize": 5
    }
  },
  "activePlayerName": "Player_1_Name",
  "activePlayerId": 1
}

• A GET request to obtain the status of a given Player, in a given Game. This is used to render the given Players Deck and Discard piles, and draw cards from the Deck.
• Example Request:

GET api/v1/games/1/players/1

• Example Response:

Status: 200
BODY: {
  "playerId": 1,
  "deck": [
    {
      "name": "Copper",
      "category": "Money",
      "cost": 0,
      "victoryPoints": 0,
      "spendingPower": 1,
      "buyingPower": 0,
      "actionsProvided": 0,
      "cardsToDraw": 0,
      "image": "copper.jpg",
      "desc": "",
      "tags": []
    },
    ...
  ],
  "discard": [
    {
      "name": "Market",
      "category": "Action",
      "cost": 5,
      "victoryPoints": 0,
      "spendingPower": 1,
      "buyingPower": 1,
      "actionsProvided": 1,
      "cardsToDraw": 1,
      "image": "market.jpg",
      "desc": "",
      "tags": ["+1 Card", "+1 Action", "+1 Buy", "+1 Gold"]
    },
    ...
  ]
}

• A POST request to indicate the end of a specific Players turn, and send all pertinent information to be updated. This includes their Deck Cards, their Discard Cards, and any Cards they bought during the course of their turn. Deck and Discard Cards are sent as an Array of Card ID's, indicating the order of Cards to be drawn next turn, and in which order they should appear in the Discard pile. On a successful request, the Game turn counter will be advanced, moving from the current Player to the next in the queue.
• Example Request:

POST api/v1/endturn
BODY: {
  "gameId": 123,
  "playerId": 234,
  "deck": [ 5, 2, 7, 11, 10 ],
  "bought": [ 12, 13 ],
  "discard": [ 3, 1, 9, 4, 8, 6, 12, 13 ]
}

• Example Response:

Status: 200
BODY: {
  "Message": "Player Tom turn ended"
}

• Because the Accession Server is built using Rails, the project is set up for testing using the RSpec framework with its robust Rails integration. All tests written are setup inside the spec, there are no required seeds or files to run our test suite.
• The Accession Server uses SimpleCov to track test coverage on our code. The coverage folder that SimpleCov generates is in .gitignore, but you should still be able to check coverage by opening the index.html files after running the test suite. Code coverage is currently at 100%, so any further contributions should follow this lead.
• To run all of our specs using RSpec, in the terminal: rspec or bundle exec rspec

Accession was a collaboration between students in the Backend and Frontend programs at the Turing School of Software and Design in Denver, Colorado. Everything was planned, programmed, and deployed in 13 days as our last project before graduation. Contributors are as follows:

• Brennan Ayers
• Patrick Duvall
• Chris Davis

• Kevin Krato
• Vinton Te'o

• Apply Backend and Frontend teams into one application
• Use professional workflow techniques (Agile, CI/CD) to create quality code
• Push ourselves outside of our comfort zone by creating a synchronous game with web technologies