112 lines
3.7 KiB
HTML
112 lines
3.7 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>JSDoc: Home</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">Home</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3> </h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article><h1>Fantasy Football</h1>
|
||
|
|
<h2>EECS 448 - Projects 3 & 4</h2>
|
||
|
|
<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>
|
||
|
|
<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>Works Cited</h2>
|
||
|
|
<p>The files in the <code>lib</code> directory 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>
|
||
|
|
</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>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-routing.html">routing</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="AddPlayersComponent.html">AddPlayersComponent</a></li><li><a href="DraftBoardComponent.html">DraftBoardComponent</a></li><li><a href="GridActionButtonComponent.html">GridActionButtonComponent</a></li><li><a href="GridComponent.html">GridComponent</a></li><li><a href="LeagueComponent.html">LeagueComponent</a></li><li><a href="LinkComponent.html">LinkComponent</a></li><li><a href="module-routing-Router.html">Router</a></li><li><a href="MyTeamComponent.html">MyTeamComponent</a></li><li><a href="ScoresComponent.html">ScoresComponent</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#GridCellRenderType">GridCellRenderType</a></li></ul>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sun Oct 25 2020 12:32:18 GMT-0500 (Central Daylight Time)
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script> prettyPrint(); </script>
|
||
|
|
<script src="scripts/linenumber.js"> </script>
|
||
|
|
</body>
|
||
|
|
</html>
|