mrstandu33 / oclock-memory-front

O'clock MemoGame - Front App

O'clock MemoGame is a project made for the O'clock memory game challenge.

You may find the OpenAPI API documentation here You will need to use Insomnia to read the OpenAPI specifications.

You may find the API here

Installation

You will need a package manager, like NPM or Yarn to install SansPriseDeBot.

For following commands, you can replace npm with yarn depending your preferences First, install dependencies by running

npm install

Configuration

Once project is initialized, you may replace values inside the settings.js file inside public/js folder and set your settings.

Usage

If you want to run it, just upload your project on a webserver, or use a local webserver. You may want to build CSS files by running

npm run sass

You can also run lint by running

npm run lint

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

GNU GPLv3