QuestQuill API

About

This app serves as a Dungeous and Dragons, Dungeon Master's Companion App and leverages the power of AI to create curated adventures for a DM and their party.

This app is a one-stop-shop companion for a DM to create adventures for their party. Create towns with stories and characters that feel believable. Follow those stories into dungeons that are fully populated with loot and combat encounters (both of which can be randomly generated based on the theme and the party’s level). Using the power of AI lifts HOURS of work from the DM as they work to create a campaign.

This is the back-end repository of this app. Please see HERE for the front-end repository.

Features

• Passwordless Login
• Campaign Manager: See a list of all campaigns
• Town Generator: Generate a town or city with specific stipulations (location, commerce, leadership, taverns, shops, notable and random NPCs, and QUESTS)
• NPC Generator: Generate an NPC with specific stipulations (name, race, gender, abilities, personality traits, etc)

Built With:

• Ruby 3.2.2
• Rails 7.0.8
• RSpec 3.12

Branch Naming Conventions

When branching on this repo please use the conventions of sprint#_name_feature

API Usage

• This app uses:
  • OpenAI API
  • D&D 5e SRD API

Configuration

1. bundle install
2. rails db:{drop,create,migrate,seed}

How to run the test suite

Run bundle exec rspec

Contributors

• Ethan Van Gorkom | GitHub | LinkedIn
• Eliza Keating | GitHub | LinkedIn
• Dylan Timmons | GitHub | LinkedIn
• John O'Leary | GitHub | LinkedIn
• Noelle Hemphill | GitHub | LinkedIn

API Documentation

API Documentation