A combat tracker for DnD 5E

Go to Website

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Deployment

• Author

About The Project

This is designed for new and experenced players to have a dynamic and streamed line combat experence while still maintatining that customisation and freedom that DnD creates.
How to use it:

Have the dungeon master load Player Character stats into the PC section. Search which moster from the 5E monster manual you would like to use. Edit the monster HP to your preference for the encounter. When its time, select the 'Begin Combat' button. Input the iniative roles and the app will auto assign intiative order. From here just play, The app tracks HP and it will rotate through the combat order through the next turn button.

Built With

The application has been built using React in the frontend. node with Express have been used for the backend. With PostgreSQL as a database.

Languages	Libraries	Framework	Database

Getting Started

If you are a developer and want to use our application, follow the steps below.

Prerequisites

Download python, it is not needed for the app to run but there are add-ons that require it. install postgreSQL, if you need help with this follow the guide here:

Installation

1. clone the app

   git clone https://github.com/coffiey/VDSM
   create migration command
   npm run migrate-create --name=<migration Name>

2. install all the packages

   useing the postgreSQL terminal create a database for the server to use.
   npm install
   npm run migrate-latest

3. Create a .env.local file. Add the following to the file:

   DB_USER = [your PSQL username]
   DB_PASSWORD = [your PSQL Password]
   DB_NAME = [your PSQL Database Name]
   
   NODE_ENV = development

4. start the server:

   cd into working directory
   npm run serve
   (this will start nodemon which allows for hot reloading of the server)

5. In a new Terminal start the React Virtial DOM

   npX react-scripts start
   (this allows for hot reloading on the frontend)

6. Enjoy the app! Please play around all you want and any bugs you find let me know.

Deployment

You can find a up to date version of the app already deployed at ###### so feel free to sign up there and enjoy the website there. However if you want to deploy it yourself as a test or to have a private server for you own game I have no problem with doing that. Please just dont try to sell this service, it is against the licencing agreement and also just a bad faith thing to do. But if you just like a fast response time, or a just really really really far away from singapore I want users to have that option.

1. Create a Database Through your deployment

   save appropriate database Url.

2. set up Deployment Enviroment Variables

   DB_URL = [Provided by Deployment]
   NODE_ENV = deployment
   generate random key
   require("crypto").randomBytes(64).toString('hex')

3. Run deployment setup command

   npm run build
   (this will install, build and migrate for you)

4. start Server

   npm run serve
   (the static build file is served by the root directory of the server, so running the command will load both front and backend.)

Author

Adam Burrough

Checkout some of my other work.

Tokyo Traders

Tokyo Traders Website Tokyo Traders Git Hub