|
7 months ago | |
---|---|---|
documentation | 7 months ago | |
lib | 7 months ago | |
src | 7 months ago | |
.DS_Store | 7 months ago | |
.gitignore | 7 months ago | |
README.md | 7 months ago | |
buttonArrow.png | 7 months ago | |
index.html | 7 months ago |
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:
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