Skip to content

Track your DnD encounters effortlessly with our website. Get real-time updates, manage players & battles, and never miss a beat.

Notifications You must be signed in to change notification settings

JeremyMees/dnd-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

D&D Tracker

Nuxt Node.js Version npm Version

A modern web application designed to streamline your D&D encounter management experience. Say goodbye to the hassle of manual tracking and hello to smooth, efficient gameplay sessions.

Features

  • Campaign Management: Organize and track your D&D campaigns with ease
  • Encounter Management: Streamline your combat encounters and keep track of initiative, HP, and status effects
  • Homebrew Management: Create and manage custom content for your campaigns

Tech Stack

Getting Started

Prerequisites

  • Node.js >= 22.0.0
  • npm >= 10.0.0

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/dnd-tracker.git
cd dnd-tracker
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

The application will be available at http://localhost:3000

Development Commands

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run generate - Generate static site
  • npm run preview - Preview production build
  • npm run lint - Run ESLint
  • npm run lint:fix - Fix ESLint errors
  • npm run typecheck - Run TypeScript type checking

Testing

Unit Tests

npm run test

End-to-End Tests

npm run e2e

Contributing

We welcome contributions to D&D Tracker! Here's how you can help:

  1. Fork the repository
  2. Create a new branch for your feature (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the test suite to ensure everything works:
    npm run test
    npm run e2e
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Pull Request Requirements

  • All code changes must be made via Pull Requests
  • PRs must be approved by a code owner
  • All automated workflows must pass:
    • Linting checks
    • Unit tests
  • Code should follow the existing style and patterns
  • Include tests for new features
  • Update documentation as needed

About

Track your DnD encounters effortlessly with our website. Get real-time updates, manage players & battles, and never miss a beat.

Topics

Resources

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Languages