michaelhjung/hatch

📖 Table of Contents

• 💡 About Hatch
• 🛠 Built With
• 🔍 Sample Features
• 🚀 Getting Started
• 💬 Contact
• 📆 Capstone Project Timeline

💡 About Hatch

Hatch is an original virtual escape room designed by Michael Jung. This project utilizes various concepts learned throughout the App Academy bootcamp program and implements them as clues to advance in the game.

Github | Live Link

AN IMPROVED 2.0 VERSION IS COMING SOON!

📚 Project Wiki Links

• 🗄️ Backend API Documentation
• 💾 Database Schema
• 📖 User Stories
• 🗒️ Features List
• 🏪 Redux State Shape
• 🖼️ Wireframes
• 🎬 BTS/Game Walkthrough
• 🙋 Why Hatch?

🛠 Built With

👨‍💻 Frameworks, Platforms, & Libraries:

🗃️ Database:

🌐 Hosting:

⬆ back to top

🔍 Sample Features

Enter Room Animation

Interact with Room Elements to find Clues

Create, Read, Update, Delete Notes

Create, Read, Update, Delete Items

Countdown Timer that Persists Across Refreshes or URL Changes

Re-enter Last-Entered Room

⬆ back to top

🚀 Getting Started

⚙️ Local Setup Instructions

1. Clone the repo:

   git clone git@github.com:michaelhjung/hatch.git

2. Install packages

   pipenv install
   cd react-app
   npm install

3. Create a .env file and set the environment variables for SECRET_KEY and DATABASE_URL to your choosing.

4. Migrate and seed the files.

   flask run db init
   flask run migrate
   flask seed all

5. Run the server and start the react app

   pipenv run flask run
   cd react-app
   npm start

💬 Contact

⬆ back to top

📆 Capstone Project Timeline

Date	Accomplishments
Sat, 10/22/2022	Decide on idea Start finding assets Create repo
Sun, 10/23/2022	Come up with riddles/clues to implement Finish first draft of API documentation Create DB schema Draft redux store shape Draft features list Create wireframe
Mon, 10/24/2022	Receive project approval Create logo Create all backend models Create backend API routes
10/25/2022	Revise schema Add room images table Complete API routes for room images table Complete storyboarding Create test seed data Create Postman tests for all backend routes Update wireframe
Wed, 10/26/2022	Photoshop hero image Finish login/signup forms with error validations Complete demo user button Complete footer Complete profile button
Thu, 10/27/2022	Implement all CRUD features for notes and items Complete Rooms and Event Logs reducers
Fri, 10/28/2022	Complete game logic for rooms 1, 2, and 3
Sat, 10/29/2022	Finish implementing logic for the remaining rooms Implement game initialization logic upon sign up (auto-creates all rooms with associated images and logs, starter notes and items)
Sun, 10/30/2022	Add cleanup functions Update splash page
Mon, 10/31/2022	Finish hero image animation Implement reset game data button Update form labels to show when typing Update CSS
Tue, 11/1/2022	Write game walkthrough wiki
Wed, 11/2/2022	Create feature for returning to last-entered room Implement countdown timer Create 404 not found page

⬆ back to top