Giter VIP home page Giter VIP logo

super-simon's Introduction

Super Simon

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!

super-simon

Live Link

https://super-simon-kappa.vercel.app/

Tech Stack

Front End

Data storage (for the leaderboard)

Linting & Formatting

Run Locally

Prerequisites

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/

Clone the repository

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 .

Environment variables

  • Create a Firebase Cloud Firestore.
  • Create a .env file in the root of the super-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=**************************

Install dependencies

To install all of the required dependencies, run npm install.

Start up the app

  • To start up the app locally, run npm run dev in your terminal. Your terminal should indicate a localhost URL at which you can view the app in your browser, most likely http://localhost:3000/.

Testing

Unit Tests

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

E2E tests are written with Playwright.

Use npm run test-e2e to run all E2E tests.

super-simon's People

Contributors

lucassilbernagel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.