D&DungeonMaster is a powerful tool that helps Dungeon Master's everywhere keep their game sessions organized and accessable.
There is a seperate repositiory for the Vue frontend.
In order to run the back-end of this project locally you will need Ruby and Ruby on Rails installed
- Clone the repo
git clone https://github.com/kpete2017/dndungeonmaster_backend.git- Install ruby gems
bundle install- Create the databse
rails db:create- Migrate the database
rails db:migrate- Seed the database
rails db:seed
From here the user can either login with the appropiate username or password or create a new account. To create a new account the user must provide a valid username, password, and name.
The homescreen is divided into four sections:
- The calculator/note section (the most left column). Here the dungeon master can pin any of his created notes or make quick calculations.
- The ally section (The top row of the middle column). From here the dungeon master can add any of their player characters or non player characters into the card layout, once clicked the card will expand out to reveal more information.
- The enemy section (The bottom row of the middle column). From here the dungeon master can add any monster or non player characters into the card layout, once clicked the card will expand out to reveal more information.
- The region/rotation/dice section(the most right column). Here the dungeon master can make quick edits to the region's information, change the turn rotation so it is easy to keep track of, and make a quick roll of the dice.
The second option down on the nav bar is the notes page. From here a dungeon master can create or delete any notes related to the campaign.
The third option down on the nav bar is the party page. From here the dungeon master can create, edit, or delete any player character. Once created here a party member can be added to the ally tab of the home page.
The fourth option down on the nav bar is the NPC page. From here the dungeon master can create, edit, or delete any non player character. Once created here a NPC can be added to either the ally secition of the home page or the enemy secion.
The fifth option down on the nav bar is the monster page. From here the dungeon master can browse every official monster from dungeons and dragons 5e. There is also a filter function which allows the dungeon master to search by name or challange rating.
The sixth option down on the nav bar is the compendium page. From here the dungeon master can browse every official spell from dungeons and dragons 5e. The First row contains the name of the spell, The second row contains the spells attributes and description, the third row (Footer) contains the classes that can use the spell. There is also a filter function which allows the dungeon master to search by name.
If you wish to contribute to the project:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Anything will be greatly appreciated!
Kyle Petersen - Linked-In - [email protected]
Project Link: https://github.com/your_username/repo_name