Barquinhos tutorial project

[SophieDeBenedetto]

We'd like to write up some pieces of documentation that will allow other mentors and mentees to go through the process of building the Barquinhos app to learn more about Elixir, Phoenix, and LiveView. We''ll produce the following docs:

• Overview - this document will outline the goals of the project and the desired end result. It will explain the game that will be built and how the game works.
• Project Phases:
  • Part I: Build the Functional Core - This document will explain what needs to built into the functional core---the board, player, ship and any other modules and their attributes and behaviors.
  • Part II: Set Up LiveView - This document will explain the next set of work: Setting up a new live view so that a user can visit /game and see some welcome message
  • Part III: Game Play - This document will break down all of the game features, starting with something like: "a user visits /game and sees the game board", "a user visits /game and sees the game board and ships", "a user visit /game and can place ships", all the way through to our complete game play in which users take turns and can win/loose.
  • Part IV: Refactoring and Tests

We'll write up each document with some sections that outline deliverables like this issue does https://github.com/groxio-learning/barquinhos/issues/37. We can leave off technical implementation details for now though.

[grace-in-wonderland]

Overview Prompts:

• [ ] What parts do we need?
• [ ] What functions (what can they do?) should they each have?
• [ ] What attributes (what are they made out of?) should each have?
• [ ] How many ships should the players have?
• [ ] What size is each boat? Are any the same size?

More on our discussion of the overview section: https://docs.google.com/document/d/1bzML9K6n5q-qSuT1iEMzo-Z8vmMinQ6p6vlsxKmcaXU/edit

[jacquelineIO]

I created a folder, so we'll be able to create multiple docs if needed. Started off with one doc today that talked about the Overview mentioned here.

[SophieDeBenedetto]

Some notes on the Player module instructions:

The Player Module

The Player module represents a game player. It has attributes that describe a player and some functions that handle player behavior.

Behavior

• Register your shots as a player - We should be able to add to the player struct's list of shots made.
• A player can join a game

Attributes

• A player struct should know its list of shots (shots the player has made)
• A player should know its unique ID
• A player should know if it has won or lost - Later, during the game play, we will calculate if the player has won or lost and update this attribute.
• A player should know if they are ready to start playing - Later, during the game play, we will calculate if the player has put all their ships on the board and update this attribute to 'true' when they have.

CRC Functions

• The Player module should implement a constructor function that returns a new player struct
• The Player module should implement at least three reducers:
  • One to add a shot to the shots list
  • One to update the ready attribute
  • One to update the lose attribute

[herminiotorres]

The Ship Module

The Ship module represents a ship on a board. It has attributes that describe a player and some functions that handle player behavior.

Behavior

• Indicates the ship its hit? Define a function that takes in two arguments: the ship struct and a shot coordinate. The function returns true if the shot is in the ship’s list of points.
• Indicates the ship its sunk? Define a function that takes in two arguments: the ship struct and a list with shot coordinates. The function returns true if all the ship points are contained in the list of shots.

Attributes

• A ship struct should register has own points. The points it's coordinates on board.
• A ship struct should know about the orientation, like vertical or horizontal.
• A ship struct should have its own size.
• A ship struct should have its own type.

CRC Functions

• The Ship module should implement a constructor function that returns a new ship struct.
• The Ship module should implement at least one converter:
  • Receive instructions and returns a list with points as coordinates.