This is the frontend repo for the Sunken Isles First Mates web application. Our minimal viable product (MVP) includes functionality for a user to log in to the web application through GitHub OAuth and create a campaign, create a character, and manipulate data related to the campaign that changes from week to week.
There are three main pages for a campaign - the Summary page, the Resource Management page, and the Party page.
-
The Summary page lists all the available resources for a campaign. These are all resources that have been gathered by villagers assigned by the party members of the campaign.
-
The Resource Management page lists all the available resources for a campaign, as well as contains a form where party members can assign villagers to perform certain tasks, as well as craft certain items. Note: In order to craft the item, the resources needed to craft the item MUST be in the available resources section. The Resource Management page also has an Advance Week button, which the Dungeon Master of the campaign can click and send into motion the resource gathering and item crafting, as well as advance the week.
-
The Party page lists all current party member's characters for the campaign. This includes their name, race, and class
This application is only one half of the Sunken Isles First Mates web application, and is primarily responsible for handling everything user facing (presenting the user the option to login through GH Oauth, displaying the appropriate information for a user, and displaying all the important information for creating a campaign, creating a character, and entering data into a form.
Simply put, the end user for this application is someone that loves to play the game Dungeons and Dragons, and wants an easy-to-use tool that would allow them to keep track of all the resouces they currently have in their DnD campaign. We primarily exhibited user empathy by creating a simple, web application that is mobile-friendly and responsive to different screen sizes. There are a limited number of pages, and each page has a semi-transparent background to make reading easier.
Fork and clone this repository
Fork and clone the BE repository linked above
[For both repositories]
cd into each
bundle install
rails db:{drop,create,migrate,seed}
- Sign in through the Google OAuth
This will take you to the user dashboard.
- Click 'Create Campaign'
This will bring you to a form where you will be able to enter a campaign name, and invite any additional players to your campaign with their email (they must have created an account prior).
- Click the 'Create Campaign' Button
This will navigate you to the campaign summary page, where you will see the name of the campaign, the current week (should start at 0), as well as a list of owned items.
- Select 'Management' from the Nav Bar
This will send you to the Resource Management page which will list all the available resources as well as the management form. This management form has two different sections - one for assigning villagers to perform tasks, as well as crafting any items. It must be noted that to create any item, the resources for the item must have already been gathered by the villagers. To see what resources are needed to create an item, check out the official documentation for Sunken Isles.
- Select 'Party' from the Nav Bar
This will take you to the Party page which will list all the current party member's characters currently in the party, as well as their name, class, race, and profile picture.
- Ruby 3.2.2
- Rails 7.1.2
See Screenshots
To run the test suite, in the root folder of the application:
bundle exec rspec spec
- Billy Wallace | GitHub, LinkedIn
- Jared Hobson | GitHub, LinkedIn
- Grant Davis | Grant's GitHub, LinkedIn
- Lance Butler | Lance's GitHub, LinkedIn
- Logan Finnegan | GitHub, LinkedIn