Maze

<br />

<p align="center"> <h1 align="center">Hamburger Maze </h1> <p align="center"> React/Material-ui <br /> [Live Version](https://serene-mestorf-79f912.netlify.app/) <br /> <a href="https://github.com/bafiam/maze.git"><strong>Explore the docs »</strong></a> <br /> <br /> · <a href="https://github.com/bafiam/maze/issues">Report Bug</a> · <a href="https://github.com/bafiam/maze/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS -->

Table of Contents

• About the Project
• Play
• Screenshots
• Prerequisites Installations
• Technology used
• Usage/Getting Started
• Live Version
• Roadmap
• License
• Authors

<!-- ABOUT THE PROJECT -->

About The Project

This project is a Hamburger Maze App built with only React framework [using hooks]. It is a game that is intended for anyone who enjoys solving puzzles and gaming.

In this project, the complete feature of the app renders the following:

• Render the board in the number of squares given by the user
• Place your player roughly in the center of the board.
• Generate the Hamburger Sprites randomly on the board.
• Count the steps it takes for the player to eat all the Hamburger sprites on the board.

Play

To play use the arrow keys.

• <img src="./screenshot/keys.png" alt="screenshot3"/>

Screenshots

Home

<img src="./screenshot/entry.png" alt="screenshot1"/>

Play Board

<img src="./screenshot/entry2.png" alt="screenshot1"/>

Prerequisites Installations

<p>If you want a copy of this project running on your machine you have to install:</p>

• <a href="https://nodejs.org/en/">Node.js (v5. 2.0 or greater)</a>
• <a href="https://git-scm.com/downloads">Git version control system</a>

Technology used

• Node.js
• React
• Material-ui
• yarn
• CSS
• ES6
• Lodash

Usage/Getting Started

Once you have installed the required package shown on the Prerequisites Installations, proceed with the following steps

Clone the Repository,

your@pc:~$ git clone https://github.com/bafiam/maze.git

Move into the cloned folder

your@pc:~$ cd maze

Get the dependencies needed for the app

your@pc:~$ yarn install

Start the server and use the app

your@pc:~$ yarn start

Live Version

This is the link to the live preview. Feel free to visit.<br> Hamburger Maze<br>

<!-- ROADMAP -->

Roadmap

See the open issues for a list of proposed features (and known issues).

<!-- CONTACT -->

Authors

Stephen Gumba

• GitHub profile

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->