Skip to content

A customizable Spell Book for Dungeons & Dragons 5th Edition. Lookup spell scrolls by class and copy them into your own personal Spell Book!

Notifications You must be signed in to change notification settings

Shawntru/5e-Spellbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Dusty Tome - Turing Mod 3 Solo Project

A customizable Spell Book for Dungeons & Dragons 5th Edition. Lookup spell scrolls by class and copy them into your own personal Spell Book!

ezgif com-gif-maker

Table of Contents

Project Overview

The Dusty Tome is a customizable spell search and spell book creator for Dungeons and Dragons 5th Edition. Search for spells available to the Bard, Cleric, Druid, Paladin, Ranger, Sorcerer, Warlock, or Wizard classes. View each spell's details and add them to your own personal Spell Book. All spell scrolls added to your spell book can then be viewed in your own dusty leather-bound tome for easy lookup in game!

This application was created as part of a mod 3 challenge project in the Turing Front End Engineering course.

Installation

Clone down the repo $ git clone git@github.com:Shawntru/5e-Spellbook.git

Navigate to directory $ cd 5e-spellbook/

Install dependencies $ npm i

Start the application $ npm start

(Or just visit the deployed site here)

Technologies and Tools

  • JavaScript (ES6)
  • CSS/Scss/Sass
  • React
  • Router
  • JSX
  • Jest
  • PropTypes
  • The 5th Edition Dungeons and Dragons API Link
  • StPageFlip Github Repo
  • Travis CI
  • Heroku

Challenges

  • Integration of new component wrapper StPageFlip
  • Automatic state update for spell displays, whether or not they were inside localStorage

Wins

  • Realizing entire project scope within 5 days, including creating a robust testing suite
  • Interactive Styling
  • Creating a fast and responsive app utilizing React
  • Cemented understanding of CSS Keyframe animation by creating all animations from scratch

Screenshots

ezgif com-gif-maker (1) ezgif com-gif-maker (2) Screen Shot 2021-01-18 at 8 07 16 PM

Roadmap

Several features planned for the future include:

  • Sorting by spell level in the Spell Search view
  • One click navigation from the spell index in the Spell Book view
  • Removing spells from Spell Book through the index
  • Local Data Storage overhaul, consolidate data through stringify and storing as JSON object
  • Better dynamic/adaptive sizing

Credits

Shawn Truesdale

Shawn Truesdale GitHub Profile

About

A customizable Spell Book for Dungeons & Dragons 5th Edition. Lookup spell scrolls by class and copy them into your own personal Spell Book!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published