BrainGain is a growing collection of for-fun mini-games. Each game takes around 5 - 30 minutes to play, making it the perfect option during study breaks, recreational time, or just to de-stress and take your mind off things.
This project is associated with the University of Auckland SOFTENG 310.
Currently, 3 games are being worked on:
- Liedle - a variation of Wordle where the game has a small chance of colouring a letter incorrectly.
- Capidle - the user is presented with a map of a city. The aim of the game is to guess the city in 6 guesses.
- 2048 Expert - a variation of 2048 where 2 (instead of 1) new tiles are added after each move.
We hope to have at least 4 games complete by launch day (18 October 2022).
To play the games, visit our website. The main branch is automatically deployed to the website.
It is possible to edit the code without installing any tools or software, by simply opening src/index.html in your browser.
However, you get a much better development experience by following these steps:
Initial set up:
- Use Visual Studio Code as your IDE. We also recommend Prettier for code formatting.
- Install NodeJS (Choose either "LTS" or "Current")
- Clone this repository
- Open this repository folder in your terminal, and run
npm install
Starting the app:
- Open this repository folder in your terminal, and run
npm start - Visit http://localhost:1234 in your web browser.
Running tests:
- Follow the instructions above to start the app. Keep that terminal window open.
- Make sure Cypress is installed
- Open this repository folder in your terminal, and run
npm test - The Cypress app will open. Click E2E Testing
- Chose a browser and click Start
- All code lives in the folder called src. Tests are written using Cypress, and are located in the folder called cypress/e2e.
This project is licensed under the terms of the MIT License
Please visit our contributing guidelines
Liedle is inspired by Wordle
2048 Expert is inspired by 2048
Capidle is inspired by Flagle, GeoGuessr and Wordle
Replay button icon from Font Awesome Icons
Liedle word list The Stanford GraphBase
In Capidle, the aerial imagery is sourced from Toitū Te Whenua Land Information New Zealand, and licensed under CC-BY 4.0. The location of cities is sourced from Wikidata, licensed under CC-0.