Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,59 @@ The project gave me hands‑on experience with Spring Boot, REST design, Dockeri

---

## Live Demo
## Play Online

<a href="https://haunted-house.bdtripp.com/" target="_blank">Play Haunted House</a><br><br>
(Runs in your browser with no installation required.)

---

## Running the Project Locally (for developers)

If you'd like to explore the source code or run the engine on your own machine, you can launch the full stack (Java backend + web frontend) using either Docker or Maven.

### 1. Clone the Repository

```bash
git clone https://github.com/bdtripp-dev/haunted-house.git
cd haunted-house
```

### 2. Launch the Application

You can run the application using Docker (production‑like environment) or Maven (best for active development).

#### Option A: Docker (Recommended)

This builds and runs the application in a clean, reproducible environment.

```bash
docker build -t haunted-house .
docker run -p 8080:8080 haunted-house
```

#### Option B: Maven

Uses the Maven Wrapper so the project builds even if Maven isn’t installed globally.

```bash
./mvnw spring-boot:run
```

### 3. Access the Game

Once the application starts, open your browser to:

http://localhost:8080

This loads the web‑based terminal interface.

---

## Gameplay

Here’s what the game looks like in action:

<img src="docs/images/gameplay.gif" width="750" alt="Gameplay screenshot showing the terminal interface and a room description">

---
Expand Down
Loading