Code Quest

By Chris Quattrochi, Simi Oyin, Jonathan Song, Trent Dietzel

About
Technologies Used
Features
Installation
Known Bugs
Feedback
License

About

This project is a full-stack web application designed as an interactive game experience called "CodeQuest". It combines frontend components built with React and backend functionalities using Node.js, Express.js, and MongoDB. The application simulates a game environment where users progress through stages by solving puzzles and making strategic choices.

Features

Gameplay Mechanics: Users navigate through stages with multiple doors, each hiding different puzzles. They can select doors, reveal puzzles, and make choices that affect their progression in the game.
Quest Guide: A detailed guide (/quest-guide) provides instructions and strategies for playing the game effectively.
Interactive UI: The frontend utilizes React components and React Router for seamless navigation and a dynamic user interface.

Technologies Used

Frontend

React: JavaScript library for building user interfaces.
React Router DOM: Library for routing in React applications.
react-dom: Provides DOM-specific methods for React components.
@testing-library/jest-dom: Testing utilities for Jest.
@testing-library/react: Testing utilities for React components.
@testing-library/user-event: Utility for triggering user events in tests.
web-vitals: Library for measuring web performance metrics.

Backend

Express: Fast, minimalist web framework for Node.js.
Mongoose: MongoDB object modeling for Node.js.
dotenv: Loads environment variables from a .env file into process.env.
axios: Promise-based HTTP client for the browser and Node.js.
cors: Middleware for enabling Cross-Origin Resource Sharing (CORS) in Express.js.

Installation

Follow these steps to set up the project locally:

Open Git BASH Download Link

Clone the repository to your local machine:

git clone https://github.com/simioyin222/CodeQuest-Monty-Hall

Open the project directory:
```
cd CodeQuest-Monty-Hall
```
Open in a code editor like Visual Studio Code.

To Start Backend:

Open the backend directory using the terminal:
```
cd backend
```
Open the VS Code terminal and install the backend dependencies:
```
npm install
```
Once installed start the backend server:
```
node server.js
```

To Start Frontend:

Open the frontend directory using the terminal:
```
cd frontend
```
Open the VS Code terminal and enter this command to install needed dependencies:
```
npm install
```
Then once installed to view in browser or to use for further development run:
```
npm run start
```

Known Bugs

None! If you see an issue, please report it on the issues page.

Feedback

We welcome any feedback or suggestions you may have. Feel free to reach out to us via GitHub or email.

⚖️ License

MIT License

Copyright (c) 2023 Chris Quattrochi, Simi Oyin, Jonathan Song, Trent Dietzel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

tdietzel/CodeQuest