Board Together is a board game platform that allows users to create their own profiles and list their favorite board games. It utilizes GraphQL and PostgreSQL to create a seamless user experience and features API calls to the popular Board Game Atlas API to provide up-to-date information about various board games. With this platform, board game enthusiasts can keep track of their collection, discover new games to play, and connect with others who share their interests. The platform is easy to use and accessible to anyone who loves board games or wants to learn more about them.
Board Together is a full-stack application combining a React frontend deployed to Surge, and Ruby on Rails backend deployed to Heroku. The frontend handles client-side tasks and displays data from the backend, which handles server-side logic and database operations. Deployment involves building the React frontend, integrating it with the Rails backend, and pushing the code to Heroku. The application can be accessed at the Surge URL.
- Implement GraphQL into Rails application to make API calls.
- Work in a full-stack development team.
- Utilize continuous integration with CircleCI.
Board Together utilizes a service oriented architecture with separate backend and frontend services. Installation instructions for the backend repository below. Frontend installation instructions can be found in the repository section. The Postman mock server below can be used to test the available endpoints. Expected request and response formats are listed for CRUD functionality.
- Frontend: https://github.com/board-together/FE-Board-Together
- Backend: https://github.com/board-together/BE-Board-Together
- Clone the repository.
- cd into the target directory.
- Install gem packages:
bundle install. - Setup the database:
rails db:{create,migrate,seed}. - Sign up for a Board Game Atlas Client ID.
- Install figaro:
bundle exec figaro install. - In your
application.ymlfile - assign your Board Game Atlas api key to a variable. This will need to be passed in as query params with keyclient_id. - To run local RSpec test suite:
bundle exec rspec, all tests should be passing.
- Factory Bot Rails
- Faker
- Faraday
- Figaro
- GraphQL Ruby
- GraphiQL Rails
- Pry
- Pry Rails
- Rack CORS
- RSpec Rails
- RuboCop GraphQL
- RuboCop Rails
- RuboCop RSpec
- SimpleCov
- Shoulda-Matchers
- Webmock
- VCR
Endpoints are run through GraphQL queries. Expand a section below for query requests and expected responses.
Find All Users
Returns a list of all current users in database.
query {
users {
id
username
}
}
Expected Response:
{
"data": {
"users": [
{
"id": 1,
"username": "Pickafloof"
},
{
"id": 2,
"username": "Floofything"
}
]
}
}Find a Specific User
Return information about a specific user in the database.
query {
user(username: "emerita") {
id
username
userGames {
id
userId
gameId
status
borrowerId
game {
id
boardGameAtlasId
url
name
yearPublished
minPlayers
maxPlayers
minPlaytime
maxPlaytime
minAge
description
thumbUrl
imageUrl
}
}
borrowedGames {
id
userId
gameId
status
borrowerId
game {
id
boardGameAtlasId
url
name
yearPublished
minPlayers
maxPlayers
minPlaytime
maxPlaytime
minAge
description
thumbUrl
imageUrl
}
}
}
}
Expected Response:
{
"data": {
"user": {
"id": "1",
"username": "emerita",
"userGames": [
{
"id": "1",
"userId": 1,
"gameId": 1,
"status": 0,
"borrowerId": 1,
"game": {
"id": "1",
"boardGameAtlasId": "abd6a0",
"url": "http://keeling.net/jae.dach",
"name": "Kirby's Epic Yarn",
"yearPublished": 1998,
"minPlayers": 1,
"maxPlayers": 13,
"minPlaytime": 19,
"maxPlaytime": 39,
"minAge": 1,
"description": "Commodi tempora dolorem. Placeat nihil sunt. Ut perspiciatis qui.",
"thumbUrl": "http://mcclure.org/bertram.moen",
"imageUrl": "https://loremflickr.com/300/300"
}
}
],
"borrowedGames": [
{
"id": "1",
"userId": 1,
"gameId": 1,
"status": 0,
"borrowerId": 1,
"game": {
"id": "1",
"boardGameAtlasId": "abd6a0",
"url": "http://keeling.net/jae.dach",
"name": "Kirby's Epic Yarn",
"yearPublished": 1998,
"minPlayers": 1,
"maxPlayers": 13,
"minPlaytime": 19,
"maxPlaytime": 39,
"minAge": 1,
"description": "Commodi tempora dolorem. Placeat nihil sunt. Ut perspiciatis qui.",
"thumbUrl": "http://mcclure.org/bertram.moen",
"imageUrl": "https://loremflickr.com/300/300"
}
},
{
"id": "2",
"userId": 2,
"gameId": 2,
"status": 0,
"borrowerId": 1,
"game": {
"id": "2",
"boardGameAtlasId": "ee0b20",
"url": "http://hane.io/cecil",
"name": "Team Fortress 2",
"yearPublished": 2016,
"minPlayers": 2,
"maxPlayers": 7,
"minPlaytime": 26,
"maxPlaytime": 4,
"minAge": 6,
"description": "Nobis fugiat voluptatem. Et quasi officia. Ut officiis doloremque.",
"thumbUrl": "http://glover-stoltenberg.biz/monique",
"imageUrl": "https://loremflickr.com/300/300"
}
},
{
"id": "3",
"userId": 3,
"gameId": 3,
"status": 0,
"borrowerId": 1,
"game": {
"id": "3",
"boardGameAtlasId": "85c360",
"url": "http://treutel.name/adella",
"name": "Animal Crossing: New Leaf",
"yearPublished": 1929,
"minPlayers": 1,
"maxPlayers": 13,
"minPlaytime": 17,
"maxPlaytime": 21,
"minAge": 7,
"description": "Ut consectetur sed. Qui alias iusto. Iusto autem aut.",
"thumbUrl": "http://hilpert.io/robt",
"imageUrl": "https://loremflickr.com/300/300"
}
},
{
"id": "6",
"userId": 6,
"gameId": 6,
"status": 0,
"borrowerId": 1,
"game": {
"id": "6",
"boardGameAtlasId": "35999c",
"url": "http://glover-mohr.com/alaina",
"name": "Luigi's Mansion",
"yearPublished": 2002,
"minPlayers": 2,
"maxPlayers": 17,
"minPlaytime": 6,
"maxPlaytime": 29,
"minAge": 11,
"description": "Sed ea nostrum. Porro doloremque nemo. Est impedit minima.",
"thumbUrl": "http://stiedemann-moore.org/victor_koelpin",
"imageUrl": "https://loremflickr.com/300/300"
}
},
{
"id": "10",
"userId": 10,
"gameId": 10,
"status": 0,
"borrowerId": 1,
"game": {
"id": "10",
"boardGameAtlasId": "a1d70a",
"url": "http://mosciski.com/zachary_nolan",
"name": "Half-Life: Opposing Force",
"yearPublished": 1987,
"minPlayers": 2,
"maxPlayers": 5,
"minPlaytime": 20,
"maxPlaytime": 4,
"minAge": 3,
"description": "Officiis magni dolor. Voluptas qui necessitatibus. Voluptatem dicta accusantium.",
"thumbUrl": "http://langworth.info/florentino",
"imageUrl": "https://loremflickr.com/300/300"
}
}
]
}
}
}Create a New User
Create a new user in the database.
mutation {
createUser(input:{username: "Foofything"}) {
user {
id
username
}
errors
}
}
Expected Response:
{
"data": {
"user": {
"id": "11",
"username": "Floofything"
},
"errors": []
}
}Delete a User
Deletes a user in the database.
mutation {
deleteUser(input: {id: 2}) {
id
errors
}
}
Expected Response:
{
"data": {
"deleteUser": {
"id": "2",
"errors": []
}
}
}Save a Game to a User
This creates a game if it does not exist in the database. It also creates a relationship between the game and the given user. The response will give a unique UserGame ID that is used in other queries to update or delete the User and Game association.
mutation {
createUserGame(input: {
userId: 4,
boardGameAtlasId: "OIXt3DmJU0",
url: "https://www.boardgameatlas.com/game/OIXt3DmJU0/catan",
name: "Catan",
yearPublished: "1995",
minPlayers: "3",
maxPlayers: "4",
minPlaytime: "45",
maxPlaytime: "90",
minAge: "10",
description: "settlers of catan",
thumbUrl: "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1629324722072.jpg",
imageUrl: "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1629324722072.jpg"
}) {
user {
id
username
userGames {
id
userId
gameId
status
borrowerId
game {
id
boardGameAtlasId
url
name
yearPublished
minPlayers
maxPlayers
minPlaytime
maxPlaytime
minAge
description
thumbUrl
imageUrl
}
}
}
}
}
Expected Response:
{
"data": {
"createUserGame": {
"user": {
"id": "4",
"username": "fred.ferry",
"userGames": [
{
"id": "4",
"userId": 4,
"gameId": 4,
"status": 0,
"borrowerId": 1,
"game": {
"id": "4",
"boardGameAtlasId": "0a23b7",
"url": "http://parker.name/jonna.lakin",
"name": "Dota 2",
"yearPublished": 1922,
"minPlayers": 2,
"maxPlayers": 8,
"minPlaytime": 5,
"maxPlaytime": 43,
"minAge": 7,
"description": "Placeat voluptas vero. Autem et voluptatem. Maxime est ut.",
"thumbUrl": "http://schmeler.name/elia.beier",
"imageUrl": "https://loremflickr.com/300/300"
}
},
{
"id": "11",
"userId": 4,
"gameId": 11,
"status": 0,
"borrowerId": null,
"game": {
"id": "11",
"boardGameAtlasId": "OIXt3DmJU0",
"url": "https://www.boardgameatlas.com/game/OIXt3DmJU0/catan",
"name": "Catan",
"yearPublished": 1995,
"minPlayers": 3,
"maxPlayers": 4,
"minPlaytime": 45,
"maxPlaytime": 90,
"minAge": 10,
"description": "settlers of catan",
"thumbUrl": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1629324722072.jpg",
"imageUrl": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1629324722072.jpg"
}
}
]
}
}
}
}Update a User and Game Association
Update a UserGame in the database. Can be used for borrowing a game, returning a game and changing a game status to private. The ID required for query input will be the UserGame's unique ID.
mutation {
updateUserGame(input: {
id: 7,
borrowerId: 4,
status: 1 })
{
userGame {
id
borrowerId
status
}
errors
}
}
Expected Response:
{
"data": {
"updateUserGame": {
"userGame": {
"id": "7",
"borrowerId": 4,
"status": 1
},
"errors": []
}
}
}Remove a User and Game Association
Delete a game from a user's owned games list. The ID required for query input will be the UserGame's unique ID.
mutation {
deleteUserGame(input :{
id: 1
}) {
id
errors
}
}
Expected Response:
{
"data": {
"deleteUserGame": {
"id": "1",
"errors": []
}
}
}Search for Games
Search for a game matching user input. Results include partial matches.
query {
searchGames(name: "Catan") {
boardGameAtlasId
url
name
yearPublished
minPlayers
maxPlayers
minPlaytime
maxPlaytime
minAge
description
thumbUrl
imageUrl
}
}
Expected Response:
{
"data": {
"searchGames": [
{
"boardGameAtlasId": "OIXt3DmJU0",
"url": "https://www.boardgameatlas.com/game/OIXt3DmJU0/catan",
"name": "Catan",
"yearPublished": 1995,
"minPlayers": 3,
"maxPlayers": 4,
"minPlaytime": 45,
"maxPlaytime": 90,
"minAge": 10,
"description": "<p>The women and men of your expedition build the first two settlements. Fortunately, the land is rich in natural resources. You build roads and new settlements that eventually become cities. Will you succeed in gaining supremacy on Catan? Barter trade dominates the scene. Some resources you have in abundance, other resources are scarce. Ore for wool, brick for lumber - you trade according to what is needed for your current building projects. Proceed strategically! If you found your settlements in the right places and skillfully trade your resources, then the odds will be in your favor. But your opponents are smart too.</p>\r\n<p>To begin the game, we build the game board using hexagonal terrain tiles. Catan is born - a beautiful island with mountains, pastures, hills, fields, and forests, surrounded by the sea.</p>\r\n<p>Each of us places two small houses on spaces where three terrain hexes meet. They are our starting settlements.</p>\r\n<p>And so it begins. I roll two dice. An “11”! Each terrain hex is marked with a die roll number. Each player who owns a settlement adjacent to a terrain hex marked with the number rolled receives a resource produced by this hex. Hills produce brick, forests produce lumber, mountains produce ore, fields produce grain, and pastures produce wool.</p>\r\n<p>We use these resources to expand across Catan: we build roads and new settlements, or we upgrade our existing settlements to cities. For example, a road costs 1 brick and 1 lumber. If we do not have the necessary resources, we can acquire them by trading with our opponents.</p>\r\n<p>Each settlement is worth 1 victory point and each city is worth 2 victory points. If you expand cleverly, you may be the first player to reach 10 victory points and thus win the game!</p>",
"thumbUrl": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1629324722072.jpg",
"imageUrl": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1629324722072.jpg"
},
{
"boardGameAtlasId": "E5TYKwLTf0",
"name": "Catan: Cities & Knights",
"yearPublished": 1998,
"minPlayers": 3,
"maxPlayers": 4,
"minPlaytime": 60,
"maxPlaytime": 90,
"minAge": 10,
"description": "Dark clouds gather over the once peaceful landscape. Wild barbarians, lured by Catan’s wealth and power, maneuver to attack. Their massive warships loom against the bright orange horizon. You must be strong! Barbarians attack the weakest targets, and the victim of their onslaught will be the player who contributes the least to the defense of Catan.<br /><br /> Don’t take any chances! Field your knights!<br /><br /> In <b>Catan: Cities & Knights</b> you engage in the defense of Catan and compete to build the three great metropolises of Catan. Each of these magnificent urban centers is even more valuable than a city. They’re also immune to the dangerous barbarians. Invest in city improvements, which you acquire using three commodities of trade: coin, paper, and cloth. If you improve your culture, muster your knights, and enrich your fine cities, you will be the master of the great realm of Catan!<br /><br /><b> Components:</b><br /> 36 Commodity Cards<br /> 54 Progress Cards<br /> 6 Victory Point Cards<br /> 3 Wooden Metropolis Pieces<br /> 1 Wooden Merchant Figure<br /> 1 Custom Event Die<br /> 1 Wooden Barbarian Ship<br /> 24 Wooden Knights<br /> 12 City Walls<br /> 4 Development Flip-Charts<br /> 1 Sea Frame Piece<br /> 1 Rulebook<br />",
"thumbUrl": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1559257359245-51DYsPZcYyL.jpg",
"imageUrl": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1559257359245-51DYsPZcYyL.jpg",
}
]
}
}MVP
- CRUD functionality for User and UserGames.
- Search for a board game utilizing Board Game Atlas API.
- Add board games to User collection.
- Track board games you have borrowed and board games you have lent out.
Stretch Goals
- Add friends feature, allowing a User to add friends and see that friend's games instead of all User's games.
- Implement User authentication using a OAuth provider.
- Create board game parties, where friends can arrange get togethers to play a certain game.
- Ability to add comments or reviews to games you have, or have borrowed.
- Email notifications for requests to borrow games.
See the open issues for a full list of proposed features (and known issues).
 |
 |
 |
 |
| Annie Pulzone | Bryan Keener | Darby Smith | Michael Marchand |
 GitHub LinkedIn
|
GitHub LinkedIn
|
GitHub LinkedIn
|
GitHub LinkedIn
|
Turing School of Software Design: https://turing.edu/
Distributed under the MIT License.