lucykendall / echo

Memory Game

Echo Memory Game

Need to test your memory! Check out what is behind the seaweed to find your exotic fish friend!
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Future Improvements
4. Contact
5. Acknowledgments

About The Project

This app is an Under the Sea themed memory game that allows users to login, signup, update their account, and play a memory game.

(back to top)

### Built With

• React-Bootstrap
• Firebase
• Flippy

(back to top)

Getting Started

To get started with this app on your own machine, ensure you follow these steps.

Installation

1. Get a free API Key at firebase

2. Clone the repo

   git clone https://github.com/lucykendall/Echo

3. Install dependencies

   npm install firebase

   npm install react-router-dom

   npm install react-bootstrap

   npm i react-flippy

4. Create a .env file and make sure that your keys match the exact details in your firebase.js, i.e.

   apiKey: process.env.REACT_APP_API_KEY,

5. .env file

   REACT_APP_API_KEY=[insert api key here]

(back to top)

Future Improvements

• Leaderboard
• Database with users game history and scores
• Two factor auth
• More memory games
  • Multiplayer gameplay
  • Messaging between users

(back to top)

Contributing

Contributions are greatly appreciated!

Follow these steps to clone and make amendments to the project:

1. Fork the Project
2. Create your Feature Branch (git checkout -b [branchname])
3. Commit your Changes (git commit -m 'Add new feature')
4. Push to the Branch (git push origin [branchname])
5. Open a Pull Request

(back to top)

Contact

Project Link: https://github.com/lucykendall/Echo Live Site: https://echo-9493d.web.app/

(back to top)

Acknowledgments

• Web Dev Simplified
• General Asssembly Team

(back to top)