Quest Forge

Table of Contents

1. About The Project
   • Note
2. Demo
3. Features
4. Technologies
5. UML Diagram
6. Installation
   • Prerequisites
   • Cloning the Repository
   • Configure
   • Start
7. Contact

About The Project

Embark on a captivating text-based adventure where you shape the destiny of your hero. This immersive web application allows users to create and customize their heroic characters, making critical decisions that will ultimately determine their fate. Engage in an epic journey filled with rich storytelling, challenging choices, and unexpected twists. Craft your hero's legend in Quest Forge and discover where your decisions lead in this interactive narrative experience.

Note

This project is based on a team project that was developed with 2 other teammates. I was the main contributor for this project. I have refactored the code to be more efficient, added useContext to remove prop drilling, improved the user interface, and added mobile responsiveness. See below for the old version of the application.

• Old Quest Forge Repo

(back to top)

Demo

Here's the live link: Quest Forge

(back to top)

Features

• Character Creation: Allow users to create and customize characters by selecting their name, age, gender, race, and class.
• Interactive Quests: Provide a dynamic storytelling experience with interactive quests, choices, and outcomes.
• AI-Powered Storytelling: Utilize AI to generate engaging narratives, scenes, and character interactions.
• AWS Integration: Utilize AWS API Gateway, DynamoDB, and Lambda for backend management, data storage, and serverless computing.
• Responsive Design: Enjoy a seamless experience on various devices.
• UI/UX Improvements: Enhance the user interface and user experience to make the application more appealing and intuitive.

(back to top)

Technologies

• Frontend: React.js for a dynamic and interactive user interface.
• Backend: Node.js and Express.js for server-side logic.
• AWS Integration: AWS API Gateway, DynamoDB, and Lambda for backend management, data storage, and serverless computing
• OpenAI Integration: Chat Completions API for quest scene and quest options generation.
• Additional Libraries and Frameworks: Material UI, MUI icons.

(back to top)

UML

(back to top)

Installation

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (preferably the latest stable version)
• npm (usually comes with Node.js)
• Git for cloning the repository
• A text editor or IDE of your choice (e.g., VSCode, Sublime Text)

Cloning

This is for the frontend portion of this application. See the following readme file for backend portion: Quest Forge

1. git clone https://github.com/cleecoloma/quest-forge-api.git
2. cd quest-forge-api
3. npm install

Configure

API_KEY={AWS API Gateway Key}

Start

1. npm run dev (development mode)
2. npm run build (production mode)

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

If you have any questions or comments, don't hesitate to reach out to me at chesterleecoloma.com.

(back to top)