Skip to content

escape-link/escapelink-fe

Repository files navigation


Logo

EscapeLink

Embark on a mind-bending journey with our sleek and minimalistic escape room app. Featuring five captivating puzzles, you can challenge your wits alone or collaborate with friends to crack the codes and unravel the mysteries together. Get ready to unlock the door to adventure and test your problem-solving skills in the world of EscapeLink!

Table of Contents
  1. About The Project
  2. Overview
  3. Built With
  4. Running On
  5. Installation and Contribution
  6. How to Use EscapeLink
  7. Authors
  8. Planning Tools

About The Project

EscapeLink is a SOA app and needs both this front-end repo AND back-end repo in order to be fully functioning.

Overview

This project is built to satisfy the requirements of the Turing School of Software and Design's Capstone Project, where students come up with their own idea for an application and build it as a group project.

This application is designed for those who enjoy standard escape rooms, as well as those who appreciate puzzle and problem-solving games.

After being debriefed on the current mission, users have the option to either team up with others or embark on a solo adventure in EscapeLink. Once every team member is prepared to start the game, they are taken into the escape room, where they are presented with an intuitive and user-friendly interface that contains a handful of hidden puzzles.

(back to top)

Screenshots

⚙️ Functionality
Description Screenshot

Home Page

landing-page

Chat Feature

chat

Game

game

Victory

victory

Built With

  • GitHub Actions
  • React
  • React Router
  • Visual Studio Code
  • Vercel
  • JavaScript
  • cypress

(back to top)

Running On

  • Javascript 8.11.0
  • React 18.2.0

Installation and Contribution

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

To get a local copy, follow these simple instructions

# Fork the project

# Clone this repo to your local machine by running:
git clone [email protected]:your_username/escapelink-fe.git 

# Cd into the root directory 
cd escapelink-fe

# Install dependencies 
npm install

# Run the start script
npm start

.....OR:

See the deployed project here

(back to top)

How to Use EscapeLink

No login or registration is needed with EscapeLink, and one can choose to play solo, or with a group.

Upon arrival at the landing page, users will be prompted to choose an escape room. Once selected, users are taken to a page displaying details of the story, as well as the objective of that given escape room, and an option to start the game.

Once the game is started, users are free to click on any objects on the page to prompt a corresponding puzzle, where they can enter the solution to the given puzzle.

As soon as a user has solved the number of puzzles necessary to win a game, a victory message will be displayed, and a user will have the option to view the leaderboard for a given escape room.

(back to top)

Authors

  • Avery Berryman GitHub LinkedIn
  • Judy Ye GitHub LinkedIn
  • Mike Wood GitHub LinkedIn

(back to top)

Planning Tools

(back to top)