DKP

A web application for DKP, built with React, NextJS, TypeScript and Material UI.

• DKP
  • Deployment
  • Development
    • Setup
    • Running the app
    • Debugging the app
    • Running the tests
    • Linting, formatting and pre-commit checks
    • Dependency management
    • Migrations
    • Secrets
  • Technologies

Deployment

Each instance of this project is deployed to Vercel.

If you'd like help deploying an instance for your guild, please open an issue and we'll be happy to help.

Development

Managing a local development environment is done via the Makefile, see make help for more details.

Setup

To initialize your development environment:

# Install nvm
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

# Use the required version
nvm install
nvm use

# Install local dependencies
make local-setup

Before running the app, you will need to make a copy of .env.example named .env and provide appropriate values for the fields marked CHANGE_ME.

Running the app

By default, the app runs locally against a local postgres database.

make local-run

The application will be available at localhost:3000.

You can seed the local database with some useful test characters and raid activities by running:

make db-testdata

If you use EQ DKP Plus, you can import data from that system by running:

make db-etl-eqdkp

Debugging the app

There are two easy ways to run the app with an attached debugger.

1. Browser Debugger If you wish to debug the client, you can drop the debugger keyword into any client code and Chrome will interpret the keyword as a break-point. You can use Chrome as your debugging environment.
2. VSCode Debugger If you wish to debug the server (or client), you can use the provided VSCode launch.json configuration. Select the Run and Debug side-bar item and click play. Add break-points where desired.

Running the tests

TODO: Write some tests.

Playwright will be used for browser-based tests.

Linting, formatting and pre-commit checks

husky is used to automatically format code using a pre-commit git hook, which runs every time you run git commit.

Dependency management

This project uses yarn.

Dependencies used for release are specified in package.json under the dependencies section. All other dependencies are specified under the devDependencies section.

Migrations

This project uses prisma.

To generate a migration, add, remove or edit model files in prisma/schema and then run make db-migrate.

Secrets

To run locally, the app requires some secrets to be injected from environment variables. Specify them in .env file. See the .env.example file for details.

Technologies

The core technologies used in this application are:

Library	Description
Typescript	Strongly typed language with JavaScript transpiler
NextJS	Opinionated web framework to simplify dev, build & test tooling
React	Library for building user interfaces
tRPC	Library for typesafe API
Prisma	ORM for managing database migrations
Material UI	Design system implementation
Playwright	Library for writing and running tests