History

Lucas Brakenridge f821aa09b3 More documentation, fixed some stuff about titles.		3 years ago
..
generated	Update READMEs and documentation (#6 )	3 years ago
.gitignore	Add generated documentation (#6 )	3 years ago
README.md	More documentation, fixed some stuff about titles.	3 years ago
generate.sh	Update READMEs and documentation (#6 )	3 years ago
package.json	Add generated documentation (#6 )	3 years ago
yarn.lock	Add generated documentation (#6 )	3 years ago

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.

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.

The easiest way to run this project is by creating a basic static web server using Python. This is super simple:

Open a terminal or command prompt to the root of this project (i.e. the directory this file is in).
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.

You can preview it here. Otherwise, it is generated by JSDoc in the documentation/generated directory.

To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just:

cd documentation
./generate.sh

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.
Button animations obtained from https://codepen.io/atloomer and https://www.youtube.com/watch?v=MLfAW55_4cY , and used with permission.
HR line animations obtained from https://codepen.io/Grienauer and used with permission.