czhangy / minroll

A Diablo III utility web app

Minroll

Documentation · Report Bug

Table of Contents

• About the Project
  • Summary
  • Tech Stack
  • Features
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
• Usage
• Roadmap
• License
• Contact
• Acknowledgements

About the Project

Summary

Minroll is a utility web application for Diablo III. It aims to provide a minimalistic experience of the popular site Maxroll, containing only tier lists, a build planner, and community builds. Development for this project is complete.

The most up-to-date version of Minroll is currently deployed at: https://minroll.vercel.app/.

Tech Stack

Client

Server

Database

Deployment

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

• DATABASE_URL
• BNET_ID
• BNET_SECRET

Getting Started

Prerequisites

This project uses NPM as a package manager

Run Locally

Clone the project

git clone https://github.com/czhangy/minroll.git

Install dependencies

npm install

Start the application

npm run dev

Roadmap

• Build out Nav

  • Navbar with router links
  • Footer with social links
  • Nav menu for mobile displays

• Build Home Page

  • Welcome text
  • Link to login/planner page

• Collect data

  • Gather all gear data/assets into DB

• Build Build Sheet Component

  • Gear section
  • Skills section
  • Passives section
  • Kanai's Cube section
  • Gem sockets
  • Hoverable for data

• Build GET API routes

  • Fetch gear by class
  • Fetch skills by class
  • Fetch passives by class
  • Fetch gems

• Build Builds Page

  • Main page with list of official builds

    • Sortable by class
    • Pagination

  • Specific build page accessed by ID

    • Build sheet displaying build contents
    • Copyable into planner
    • Mobile display

• Build Tiers Page

  • List with links to individual builds
  • Filterable by class

• Build Planner Page

  • Class selection
  • Gear selection
  • Skill selection
  • Passives selection
  • Cube selection
  • Legendary Gem selection
  • Clearable dropdowns
  • Changes display on build
  • Save functionality
  • Local storage
  • Comprehensive edge case checks
  • Responsive

• Build Auth Pages

  • Login form
  • Register form
  • Redirect from /login and /register when logged in

• Build Profile Page

  • Display username

  • Logout button

  • List of saved builds

    • Update functionality
    • Delete functionality
    • Show more functionality
    • Sort by functionality
    • Alternate text

  • Redirect on unauthorized

  • Mobile display

• Build other API routes

  • Auth routes
  • POST route for builds
  • PUT route for builds
  • DELETE route for builds

• Build About Page

• Unit testing

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Charles Zhang:

Acknowledgements

• Awesome README
• Shields.io
• Maxroll
• Battle.net API
• BlizzAPI

minroll's Issues

Dropdowns are still focused on window blur

Dropdowns on the gear/skills page remain focused when blurring the window, resulting in them appearing to be active, but with the dropdown missing until the dropdown is clicked again.