OTTOMH (On The Top Of My Head) is a web-based party trivia game that challenges players to come up with as many words that start with a certain letter and belong to a certain category in a set amount of time while competing against other players.
Unlike physical board games, OTTOMH is easier to setup and can be played by geographically distributed players. It also provides a user-friendly, web-based experience similar to the popular board game Scattegories, allowing players to exercise their brains while having a good time.
Play the game here: https://ottomh.herokuapp.com/
- Invite people! Create a new lobby, copy the lobby code, and send it to your teammates.
- You have 60 seconds to submit as many words as you can think of at top of your head that begins with the given letter and matches the given category!
- Compete against time and other players! Words can only be submitted ONCE, and the first person takes the credit for it.
- Vote off words that don't match and earn points for the words that make it through the round!
- View players' scores and rankings on the scoreboard at the end of each round!
- Replay the game with the same people!
If you prefer to play the game locally instead of on the live server at https://ottomh.herokuapp.com/, then you'll need to first install the app by either cloning the main branch of this repo or download the latest released zip files under "releases".
To download the game for local use, clone the repo or download the source from the 'releases' page, then install dependencies using.
To clone the repo:
git clone https://github.com/cis3296f22/ottomh.gitFirst install the dependencies:
- Install NPM packages with
npm install. - Install Go packages with
go get.
To run the project:
- Bundle JS code with
npm run build. - Run the server with
go run server.go. - Go to localhost:8080
By default, the server listens on port 8080. If you would like to use another port, set the $PORT environment variable.
All contributions are appreciated and help support the project!
If you would like to contribute to this project, please fork this repo, then make a pull request explaining your changes and contribution. Before making a pull request, please make sure that all tests pass. Testing instructions are under the Running tests sections.
OTTOMH is built using ReactJs and Go, so you will need the npm and go commands in order to build and run the project as well as installing the necessary dependencies. Please see the build instructions under the 'Building' section of this README.
To report any issues and/or bugs, please open an issue and include the following information so we can better understand and solve the problem:
- State what the issue is
- What did you do to encounter this issue so that we can replicate it
- What browser you were using and what version was it
- Additionally, if you're running the game on a local machine, what operating system and version were you using
If you would like to make a feature request, please include in the title "Feature request:". For example, "Feature request: add light mode".
tests.sh tests the backend with coverage and tests the frontend with coverage using a variety of third-party tools. To run these tests locally you will need to take a few extra steps:
- Install go-test-report with
go install github.com/vakenbolt/go-test-report@latest. Make sure to add your GOPATH to the PATH (usually the GOPATH is~/go/bin) - Line 3 of tests.sh is configured to open an HTML file in the Brave Browser using Mac's
opencommand. You will have to edit this line if you are on a platform other than Mac. - The
time_pickedat src/components/LobbyPage/LobbyPage.js should be set to a very small value, like"00:03".
To generate documentation for the backend, start by installing godoc by running go install golang.org/x/tools/cmd/godoc@latest. Then go to the application root, and run godoc -http=:6060. You can then visit the go docs at localhost:6060. Here, search for the section labeled "ottomh".
To generate documentation for the frontend, use the jsdoc tool. Use npm i jsdoc --save-dev to install jsdoc. To generate documentation for the frontend, use jsdoc -r src. Then you can view the documentation by opening out/index.html.
- Brain image by yo_han on Freepik