The classic memory game Simon, with a twist! How long of a sequence can you remember? Super Simon is a Progressive Web App that can be played on the web, installed on your device, and even played offline!
https://super-simon-kappa.vercel.app/
In order to run this application locally, you must have node installed on your computer. To check if you already have it installed, enter node -v
in your terminal. If you do not have node, you can install it here: https://nodejs.org/en/
Once you have confirmed that node is installed, cd
into a folder on your computer and run the following command to clone the repository:
git clone https://github.com/LucasSilbernagel/super-simon.git
Then cd
into the project folder and open it in your code editor. For Visual Studio Code:
cd super-simon
code .
- Create a Firebase Cloud Firestore.
- Create a
.env
file in the root of thesuper-simon
project and save your Firebase credentials there as below:
NEXT_PUBLIC_FIREBASE_API_KEY=********************
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=*******************
NEXT_PUBLIC_FIREBASE_PROJECT_ID=*********************
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=***********************
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=*************************
NEXT_PUBLIC_FIREBASE_APP_ID=**************************
To install all of the required dependencies, run npm install
.
- To start up the app locally, run
npm run dev
in your terminal. Your terminal should indicate alocalhost
URL at which you can view the app in your browser, most likely http://localhost:3000/.
Unit tests are written with Jest and react-testing-library.
Use npm run test-unit
to run all unit tests, or use npm run test-unit SomeFileToRun
to run a specific test file.
E2E tests are written with Playwright.
Use npm run test-e2e
to run all E2E tests.