A Spelling Bee App made in JavaScript for CSCI 420: Software Enginnerring at Millersville University.
- Node.js: You'll also need to have Node.js installed on your computer. Node.js is an open-source, cross-platform JavaScript runtime environment that allows you to run JavaScript on your computer. You can download Node.js from the official website at https://nodejs.org/.
- npm: Node.js comes with npm, which is a package manager for JavaScript. npm makes it easy for JavaScript developers to share and reuse code, and it makes it easy to update the code that you're sharing. If some how npm isn't installed, you can install npm by following the instructions on the official website at https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
- Git: Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. You can download Git from the official website at https://git-scm.com/downloads.
- Homebrew: ONLY NEEDED FOR MAC OS, this is used to install specific kinds of packages for this specific OS. You can download it from the official website at https://brew.sh/
- ONLY FOR MAC OS X - run this with brew installed:
brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman
- To run the program, you'll need to clone this repository to your local computer. You can do this by using the following command in your terminal or command line interface:
git clone https://github.com/mucsci-students/2023sp-420-Maryjane.git
- After cloning the repository, navigate to the repository using the following command:
cd 2023sp-420-Maryjane
- Before you can run the program, you'll need to install the dependencies. You can do this by using the following command:
npm install
- Once you've installed the dependencies, you can run the program by using the following command:
npm run cli
-
You can run the GUI either locally or remotely:
-
Hosted Website (Remotely):
-
Click this link to be sent to the GUI host website:
-
-
Through the terminal/command line interface (Locally):
- To run the GUI through terminal/command line interface, you'll need to first clone this repository to your local computer. You can do this by using the following command in your terminal or command line interface:
git clone https://github.com/mucsci-students/2023sp-420-Maryjane.git
- Before you can run the program, you'll need to install the dependencies. You can do this by using the following command:
npm install
- Once you've installed the dependencies, you can run the GUI by using the following command:
npm run gui
- This command will make two links appear in the terminal under the "Available on" section (Picture example below). Use CNTRL-Click (Windows) or cmd-Click (MAC) on either of these links to start up the GUI:
.png)
.png)
- To run the tests, you can use the following command:
- Note: You'll need to have the dependencies installed before you can run the tests. Refer to the "Executing program" section for more information.
- Note: You need to be in the root directory of the project to run the tests. (i.e. 2023sp-420-Maryjane)
npm test
- To run the tests, you can use the following command:
- Note: You'll need to have the dependencies installed before you can run the tests. Refer to the "Executing program" section for more information.
- Note: You need to be in the root directory of the project to run the tests. (i.e. 2023sp-420-Maryjane)
npm run test -- --coverage "tests/Model.test.js"
- This will create a folder in your repo called coverage
- Go to 2023sp-420-Maryjane/coverage/Icov-report
- Open the index.html in a browser of your choice
The model contains all the data relevant to the users' current game, such as the puzzle letters, found words, possible words, and more. The views contains everything used to display the model information on either the CLI or GUI. The controller adds event listerners to the GUI to be able to handle user interaction and handles commands in the CLI.
The model (around lines 43-52 in Model.js) constructor is set up to return a new model if it is the first time the constructor is being called and saves that instance. If not, the constructor will return the previous instance. This design pattern is verified in our model test file.
We implement many ForEach loops in our code which iterate through a list of objects. For example, it can be seen in the guess commands file (Around line 47 in guessCommands.js) where we iterate over the entire possible guesses to see if the users' guess is in that array.
Our use of Vorpal commands and all commands in commands.js are object-oriented callback functions. These implementations can be found in the CLI_Controller (For example lines 55-57 in CLI_Controller).
For every button, textField, and menu item in the GUI, we have a certain event listener that listens for a specific action. For example, When you click on any hexagon button (Around line 231 in index.html), an onClick event listner calls a function in the Gui Controller (Around line 47 in GUI_Controller.js) which will then call a function in the Gui View (Around line 48 in GUI_Controller.js) that will update what letter is shown on the screen (Around line 334 in GUI_View.js).
We created a file system class called fileSystem.js to read a JSON file and parse the contents together. We can read a json file inside the CLI and GUI regardless of enviorment. Then, we created highScoreCommand.js that inherits the file system class in order to read the JSON file regardless of enviorment.
👤 Jonathan Rivera
- Github 🤖: @jjriver1
👤 Justin Stevens
- Github 🤖: @JSteve0
👤 Mitchell Harrison
- Github 🤖: @mharrison7787
👤 Jayson Gayle
- Github 🤖: @OhMyDayz2023
👤 Michael Lewis
Contributions, issues and feature requests are welcome! Feel free to check the issues page
Give a ⭐️ if this project helped you!
Distributed under the MIT License. See LICENSE for more information.