Skip to content

InstallationIssue/Mischief-Materials

Repository files navigation

GitHub License GitHub Issues or Pull Requests GitHub last commit GitHub package.json version

Mischief Materials

This is a hobby web app created to assist with running sessions of the Tabletop Game Maze Rats

Resources

To learn more about Next.js, take a look at the following resources:

This project uses next/font to automatically optimize and load a number of custom Google Fonts.

UI Resources

Database Resources

Local Deployment

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

Useful Commands

npx prisma studio # Opens prisma studio

npx prisma migrate dev # Updates database

NPM Updating & Auditing

npm audit

npm outdated

npm prune

npm update

#major version
npm install $PACKAGE

Diagrams

Mermaid Entity Relationship Documentation

Mermaid Architecture Documentation

---
title: Database ER Diagram
---
erDiagram

Scenario {
    string name
    string description
    string setting
    string image
}

Location {
    string name
    string description
    string color
    string icon
}

Character {
    string name
    string background
    int xp
    int level
    int health_max
    int health_lost
    int armor
    int strength
    int dexerity
    int will
    int attack
    string profession
    string appearance
    string physical_detail
    string clothing
    string personality
    string mannerism
    boolean npc
}

Path {
    string name
    string description
}

Monster {
    string name
    string background
    int health_max
    int armor
    int strength
    int dexterity
    int will
    string size
    int attack
    string tactics
    string personality
    string weakness
}

Item {
    string name
    string description
    int value
}

Spell {
    string name
    string description
}

Scenario }o--o{ Location : contains
Scenario }o--o{ Character : contains
Scenario }o--o{ Monster : contains
Scenario }o--o{ Item : contains
Scenario }o--o{ Spell : contains
Character }|--o{ Path : contains

Loading

Architecture

architecture-beta

group architecture[Mischief Materials Architecture]
service mischief_materials(server)[Mischief Materials Server] in architecture
junction join in hide_net

group hide_net[Hidden Network] in architecture
service randomizer(server)[Randomizer] in hide_net
service sql_db(database)[SQL Database] in hide_net
service image_db(database)[Image Database] in hide_net

service external(internet)[External]

external:R <-- L:mischief_materials
mischief_materials:R <-- L:join
join:T -- B:sql_db
join:R -- L:image_db
join:B -- T:randomizer
Loading

About

Sandbox web app designed to showcase design and facilitate faster, more centralised planning of tabletop games

Resources

License

Stars

Watchers

Forks

Contributors