cwest9400 / project-dnd-class-guide

https://warm-selkie-a2ebf0.netlify.app/
0 stars 0 forks source link

DnD Class Guide :mage:

Project Description

DnD Class Guide is for beginner players that need a class reference for 5e DnD. It attempts to showcase each class with a simple and modern look with fluid navigation. On the home page, the available classes in 5e DnD are loaded into view. The user is able to click any class and navigate to the details page. From the details page, the user can click a link to additional, off-site information about the class or, click the "DnD Class Guide" header at the top of the page to navigate back to the home page.

Future improvements will include additional class information for added depth and mobile responsiveness.

Technologies

React, JavaScript, CSS, HTML, API: https://open5e.com/, Figma, Netlify

Screen Captures of Current Version

Screen Shot 2022-12-11 at 5 04 59 PM Screen Shot 2022-12-11 at 5 05 54 PM

Getting Started/Installation Instructions:

Launch the website via https://warm-selkie-a2ebf0.netlify.app/

Wireframes

Home page wireframe

App

Character detail wireframe

ClassDetail

Lofi wireframe prototype (clickable)

https://www.figma.com/proto/TZNIIBAR31zs2bUIdPh63i/Dnd-Class-Guide-App?node-id=1%3A2&scaling=scale-down&page-id=0%3A1&starting-point-node-id=2%3A63

MVP User Stories

Stretch MVP User Stories

API

https://open5e.com/ was used to fetch DnD class data used in the app. The specific end point used was https://api.open5e.com/classes/

API data example

"next": null,
"previous": null,
"results": [
{
"name": "Barbarian",
"slug": "barbarian",
"hit_dice": "1d12",
"hp_at_1st_level": "12 + your Constitution modifier",
"hp_at_higher_levels": "1d12 (or 7) + your Constitution modifier per barbarian level after 1st",
"prof_armor": "Light armor, medium armor, shields",
"prof_weapons": "Simple weapons, martial weapons",
"prof_tools": "None",
"prof_saving_throws": "Strength, Constitution",
"prof_skills": "Choose two from Animal Handling, Athletics, Intimidation, Nature, Perception, and Survival",
"equipment": "You start with the following equipment, in addition to the equipment granted by your background: \n \n* (*a*) a greataxe or (*b*) any martial melee weapon \n* (*a*) two handaxes or (*b*) any simple weapon \n* An explorer's pack and four javelins",

Component Hierarchy

Screen Shot 2022-12-11 at 4 39 23 PM

component_heirarchy_dnd_ref_guide