||2 years ago|
|generated||2 years ago|
|.gitignore||2 years ago|
|README.md||2 years ago|
|generate.sh||2 years ago|
|package.json||2 years ago|
|yarn.lock||2 years ago|
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
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:
- 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
Re-generating the documentation
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.
- A front-end framework. Used under the terms of the MIT license.
- A kind-of crappy loader for defining Vue components using ES6 classes.
- Also used under the terms of the MIT license.
- 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.
- Lucas Brakenridge
- Javier Barea Lara
- Garrett Mills
- Evan Powell
- Alec Horlick-Mills