OrthographyOverlord is a dynamic spelling game that puts your linguistic skills to the test. This immersive game offers users a series of audio-based spelling challenges, where the player listens to recordings of words and is challenged to spell them out correctly. The user-friendly interface ensures a seamless experience as you progress through rounds of spelling tests, and for those seeking an extra thrill, you can race against the clock with the optional timer. Whether you're honing your spelling abilities or enjoying the excitement of wordplay, OrthographyOverlord provides an entertaining and educational journey for learners of all ages.
Provide here instructions on how to use your application.
-
Download the latest build for your operating system from the Release section on the right on GitHub.
-
Run and play!
Navigate to Library/Application Support/orthography-overlord-client/wordsets If the wordsets folder does not exist, create it. Any CSV files you place in this directory will be available as wordsets.
Navigate to C:\Users\YOURUSERNAME\AppData\Roaming\orthography-overlord-client\wordsets If the wordsets folder does not exist, create it. Any CSV files you place in this directory will be available as wordsets.
Follow this project board to know the latest status of the project: https://github.com/orgs/cis3296f23/projects/113
- Use this github repository to download the zipfile or clone it to your local repository:
- Specify what branch to use for a more stable release or for cutting edge development.
- Use Visual Studio Code
- Install Node and NPM
cd
into the client directory- Run
npm i
to install required packages. - Execute
npm start
ornpm run start
to start the app. - Execute
npm run make
to compile the app for release.
cd
into the server directory- Run
npm i
to install required packages. - Execute
npm start
ornpm run start
to start the server. - Access the server over http. By default, it runs on port 3050.
- Todo: Provide your own API key.