Update READMEs and documentation (#6)

master
Garrett Mills 2 years ago
parent c78612ab88
commit e22f722092
Signed by: garrettmills
GPG Key ID: D2BF5FBA8298F246
  1. 11
      README.md
  2. 51
      documentation/README.md
  3. 2
      documentation/generate.sh
  4. 2
      documentation/generated/GameBoardComponent.html
  5. 2
      documentation/generated/GameStateService.html
  6. 2
      documentation/generated/GridCellComponent.html
  7. 182
      documentation/generated/InvalidAdvanceStateError.html
  8. 181
      documentation/generated/InvalidMissileFireAttemptError.html
  9. 182
      documentation/generated/InvalidShipPlacementError.html
  10. 2
      documentation/generated/ScoreBoardComponent.html
  11. 479
      documentation/generated/Sound.html
  12. 2
      documentation/generated/TopLevelComponent.html
  13. 2
      documentation/generated/components_GameBoard.component.js.html
  14. 2
      documentation/generated/components_GridCell.component.js.html
  15. 2
      documentation/generated/components_ScoreBoard.component.js.html
  16. 2
      documentation/generated/components_TopLevel.component.js.html
  17. 1113
      documentation/generated/global.html
  18. 53
      documentation/generated/index.html
  19. 2
      documentation/generated/module-errors.InvalidAdvanceStateError.html
  20. 2
      documentation/generated/module-errors.InvalidMissileFireAttemptError.html
  21. 2
      documentation/generated/module-errors.InvalidShipPlacementError.html
  22. 2
      documentation/generated/module-errors.html
  23. 2
      documentation/generated/module-lang.html
  24. 2
      documentation/generated/module-sounds-Sound.html
  25. 2
      documentation/generated/module-sounds.html
  26. 2
      documentation/generated/module-util.html
  27. 5211
      documentation/generated/module.exports.html
  28. 2
      documentation/generated/module_errors.js.html
  29. 2
      documentation/generated/module_lang.js.html
  30. 2
      documentation/generated/module_sounds.js.html
  31. 2
      documentation/generated/module_util.js.html
  32. 2
      documentation/generated/services_GameState.service.js.html
  33. 3
      lib/README.md

@ -20,6 +20,17 @@ The easiest way to run this project is by creating a basic static web server usi
This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser.
## Documentation
You can [preview it here](https://htmlpreview.github.io/?https://raw.githubusercontent.com/EECS-448-Battleship/project-1/master/documentation/generated/index.html). Otherwise, it is generated by JSDoc in the `documentation/generated` directory.
### Re-generating the documentation
To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just:
```shell script
cd documentation
./generate.sh
```
## Contributors
- Lucas Brakenridge
- Javier Barea Lara

@ -0,0 +1,51 @@
# Battleship
## EECS 448 - Project 1
This is a basic battleship game created as our submission for project 1 for EECS 448 at the University of Kansas.
## Structure Info
This project has been wired up to use Vue.js to help organize components of the game.
These components are defined in files that end in the `.component.js` extension, and are located in the `src/components/` directory.
The entry point for the project is the `index.html`. This file contains the basic logic for loading Vue, and adding the game board to the page.
Obviously, we'll flesh out the look-and-feel as we go along. This is just a basic starter for now.
## How to Run
The easiest way to run this project is by creating a basic static web server using Python. This is super simple:
1. Open a terminal or command prompt to the root of this project (i.e. the directory this file is in).
2. Start the server: `python -m http.server`
This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser.
## Documentation
You can [preview it here](https://htmlpreview.github.io/?https://raw.githubusercontent.com/EECS-448-Battleship/project-1/master/documentation/generated/index.html). Otherwise, it is generated by JSDoc in the `documentation/generated` directory.
### Re-generating the documentation
To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just:
```shell script
cd documentation
./generate.sh
```
## Third-Party Libraries
The files in the `lib/` are external libraries used in this project.
- Vue.js
- A front-end framework. Used under the terms of the MIT license.
- https://github.com/vuejs/vue
- VuES6.js
- A kind-of crappy loader for defining Vue components using ES6 classes.
- Also used under the terms of the MIT license.
- https://code.garrettmills.dev/garrettmills/vues6
- Sound effects obtained from https://www.zapsplat.com and used with permission.
## Contributors
- Lucas Brakenridge
- Javier Barea Lara
- Garrett Mills
- Evan Powell
- Alec Horlick-Mills

@ -1,3 +1,3 @@
#!/bin/sh
yarn install
./node_modules/.bin/jsdoc --destination ./generated --recurse ../src
./node_modules/.bin/jsdoc --destination ./generated --readme ./README.md --recurse ../src

@ -1857,7 +1857,7 @@ When in placement mode, this updates the cells that show the ghost ship.
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -3102,7 +3102,7 @@ game_service.validate_coordinates(ShipType.x3, [3,2], [3,4])</code></pre>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -612,7 +612,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -1,182 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: InvalidAdvanceStateError</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: InvalidAdvanceStateError</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>InvalidAdvanceStateError<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Error thrown when the program tries to advance the state, but it is
invalid.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="InvalidAdvanceStateError"><span class="type-signature"></span>new InvalidAdvanceStateError<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_errors.js.html">module/errors.js</a>, <a href="module_errors.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>Error</li>
</ul>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GameBoardComponent.html">GameBoardComponent</a></li><li><a href="GameStateService.html">GameStateService</a></li><li><a href="GridCellComponent.html">GridCellComponent</a></li><li><a href="InvalidAdvanceStateError.html">InvalidAdvanceStateError</a></li><li><a href="InvalidMissileFireAttemptError.html">InvalidMissileFireAttemptError</a></li><li><a href="InvalidShipPlacementError.html">InvalidShipPlacementError</a></li><li><a href="ScoreBoardComponent.html">ScoreBoardComponent</a></li><li><a href="Sound.html">Sound</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appUrl">appUrl</a></li><li><a href="global.html#clone">clone</a></li><li><a href="global.html#GameState">GameState</a></li><li><a href="global.html#GridCellState">GridCellState</a></li><li><a href="global.html#instructions">instructions</a></li><li><a href="global.html#isShipCell">isShipCell</a></li><li><a href="global.html#isValidTargetCell">isValidTargetCell</a></li><li><a href="global.html#Player">Player</a></li><li><a href="global.html#ShipType">ShipType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:27:46 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>

@ -1,181 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: InvalidMissileFireAttemptError</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: InvalidMissileFireAttemptError</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>InvalidMissileFireAttemptError<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Error thrown when a missile is fired at an invalid cell.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="InvalidMissileFireAttemptError"><span class="type-signature"></span>new InvalidMissileFireAttemptError<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_errors.js.html">module/errors.js</a>, <a href="module_errors.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>Error</li>
</ul>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GameBoardComponent.html">GameBoardComponent</a></li><li><a href="GameStateService.html">GameStateService</a></li><li><a href="GridCellComponent.html">GridCellComponent</a></li><li><a href="InvalidAdvanceStateError.html">InvalidAdvanceStateError</a></li><li><a href="InvalidMissileFireAttemptError.html">InvalidMissileFireAttemptError</a></li><li><a href="InvalidShipPlacementError.html">InvalidShipPlacementError</a></li><li><a href="ScoreBoardComponent.html">ScoreBoardComponent</a></li><li><a href="Sound.html">Sound</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appUrl">appUrl</a></li><li><a href="global.html#clone">clone</a></li><li><a href="global.html#GameState">GameState</a></li><li><a href="global.html#GridCellState">GridCellState</a></li><li><a href="global.html#instructions">instructions</a></li><li><a href="global.html#isShipCell">isShipCell</a></li><li><a href="global.html#isValidTargetCell">isValidTargetCell</a></li><li><a href="global.html#Player">Player</a></li><li><a href="global.html#ShipType">ShipType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:27:46 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>

@ -1,182 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: InvalidShipPlacementError</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: InvalidShipPlacementError</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>InvalidShipPlacementError<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Placeholder class for an error that is thrown when a ship is placed
in an invalid position.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="InvalidShipPlacementError"><span class="type-signature"></span>new InvalidShipPlacementError<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_errors.js.html">module/errors.js</a>, <a href="module_errors.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>Error</li>
</ul>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GameBoardComponent.html">GameBoardComponent</a></li><li><a href="GameStateService.html">GameStateService</a></li><li><a href="GridCellComponent.html">GridCellComponent</a></li><li><a href="InvalidAdvanceStateError.html">InvalidAdvanceStateError</a></li><li><a href="InvalidMissileFireAttemptError.html">InvalidMissileFireAttemptError</a></li><li><a href="InvalidShipPlacementError.html">InvalidShipPlacementError</a></li><li><a href="ScoreBoardComponent.html">ScoreBoardComponent</a></li><li><a href="Sound.html">Sound</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appUrl">appUrl</a></li><li><a href="global.html#clone">clone</a></li><li><a href="global.html#GameState">GameState</a></li><li><a href="global.html#GridCellState">GridCellState</a></li><li><a href="global.html#instructions">instructions</a></li><li><a href="global.html#isShipCell">isShipCell</a></li><li><a href="global.html#isValidTargetCell">isValidTargetCell</a></li><li><a href="global.html#Player">Player</a></li><li><a href="global.html#ShipType">ShipType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:27:46 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>

@ -812,7 +812,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:31:00 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -1,479 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Sound</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Sound</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Sound<span class="signature">(src)</span><span class="type-signature"></span></h2>
<div class="class-description">A thin wrapper for sound effects.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Sound"><span class="type-signature"></span>new Sound<span class="signature">(src)</span><span class="type-signature"></span></h4>
<div class="description">
Construct the sound.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>src</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">URL of the file</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_sounds.js.html">module/sounds.js</a>, <a href="module_sounds.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="sound"><span class="type-signature"></span>sound<span class="type-signature"> :HTMLAudioElement</span></h4>
<div class="description">
The sound element.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">HTMLAudioElement</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_sounds.js.html">module/sounds.js</a>, <a href="module_sounds.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="play"><span class="type-signature">(async) </span>play<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Start playing the sound.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_sounds.js.html">module/sounds.js</a>, <a href="module_sounds.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Pause the sound.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="module_sounds.js.html">module/sounds.js</a>, <a href="module_sounds.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GameBoardComponent.html">GameBoardComponent</a></li><li><a href="GameStateService.html">GameStateService</a></li><li><a href="GridCellComponent.html">GridCellComponent</a></li><li><a href="InvalidAdvanceStateError.html">InvalidAdvanceStateError</a></li><li><a href="InvalidMissileFireAttemptError.html">InvalidMissileFireAttemptError</a></li><li><a href="InvalidShipPlacementError.html">InvalidShipPlacementError</a></li><li><a href="ScoreBoardComponent.html">ScoreBoardComponent</a></li><li><a href="Sound.html">Sound</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appUrl">appUrl</a></li><li><a href="global.html#clone">clone</a></li><li><a href="global.html#GameState">GameState</a></li><li><a href="global.html#GridCellState">GridCellState</a></li><li><a href="global.html#instructions">instructions</a></li><li><a href="global.html#isShipCell">isShipCell</a></li><li><a href="global.html#isValidTargetCell">isValidTargetCell</a></li><li><a href="global.html#Player">Player</a></li><li><a href="global.html#ShipType">ShipType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:27:46 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>

@ -1482,7 +1482,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:31:00 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -278,7 +278,7 @@ export default GameBoardComponent
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -102,7 +102,7 @@ export default GridCellComponent
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -151,7 +151,7 @@ export default ScoreBoardComponent
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -274,7 +274,7 @@ export default TopLevelComponent
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

File diff suppressed because it is too large Load Diff

@ -42,6 +42,57 @@
<section>
<article><h1>Battleship</h1>
<h2>EECS 448 - Project 1</h2>
<p>This is a basic battleship game created as our submission for project 1 for EECS 448 at the University of Kansas.</p>
<h2>Structure Info</h2>
<p>This project has been wired up to use Vue.js to help organize components of the game.</p>
<p>These components are defined in files that end in the <code>.component.js</code> extension, and are located in the <code>src/components/</code> directory.</p>
<p>The entry point for the project is the <code>index.html</code>. This file contains the basic logic for loading Vue, and adding the game board to the page.</p>
<p>Obviously, we'll flesh out the look-and-feel as we go along. This is just a basic starter for now.</p>
<h2>How to Run</h2>
<p>The easiest way to run this project is by creating a basic static web server using Python. This is super simple:</p>
<ol>
<li>Open a terminal or command prompt to the root of this project (i.e. the directory this file is in).</li>
<li>Start the server: <code>python -m http.server</code></li>
</ol>
<p>This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser.</p>
<h2>Documentation</h2>
<p>You can <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/EECS-448-Battleship/project-1/master/documentation/generated/index.html">preview it here</a>. Otherwise, it is generated by JSDoc in the <code>documentation/generated</code> directory.</p>
<h3>Re-generating the documentation</h3>
<p>To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just:</p>
<pre class="prettyprint source lang-shell"><code>cd documentation
./generate.sh
</code></pre>
<h2>Third-Party Libraries</h2>
<p>The files in the <code>lib/</code> are external libraries used in this project.</p>
<ul>
<li>Vue.js
<ul>
<li>A front-end framework. Used under the terms of the MIT license.</li>
<li>https://github.com/vuejs/vue</li>
</ul>
</li>
<li>VuES6.js
<ul>
<li>A kind-of crappy loader for defining Vue components using ES6 classes.</li>
<li>Also used under the terms of the MIT license.</li>
<li>https://code.garrettmills.dev/garrettmills/vues6</li>
</ul>
</li>
<li>Sound effects obtained from https://www.zapsplat.com and used with permission.</li>
</ul>
<h2>Contributors</h2>
<ul>
<li>Lucas Brakenridge</li>
<li>Javier Barea Lara</li>
<li>Garrett Mills</li>
<li>Evan Powell</li>
<li>Alec Horlick-Mills</li>
</ul></article>
</section>
@ -56,7 +107,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -174,7 +174,7 @@ invalid.</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -173,7 +173,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -174,7 +174,7 @@ in an invalid position.</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -89,7 +89,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -152,7 +152,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -471,7 +471,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -159,7 +159,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

@ -992,7 +992,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>

File diff suppressed because it is too large Load Diff

@ -63,7 +63,7 @@ export class InvalidMissileFireAttemptError extends Error {}
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:30:59 GMT-0500 (Central Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>