Blaseball Reference

Blaseball Reference is a website that provides statistics for every* player in Blaseball history.

Getting Started

Prerequisites

Git
Node: any 12.x or 13.x version
Yarn
A fork of the repo, if you wish to contribute

Installation

cd blaseball-reference.com to go into the project root
yarn to install the website's npm dependencies

Running Locally

yarn dev to start the development server
open http://localhost:3000/ to open the development server

Contribute

Create a branch

git checkout dev from any folder in your local repo
git pull origin dev to ensure you have the latest code
git checkout -b your-feature-branch dev to create your feature branch

Make your changes

Follow the "Running Locally" instructions
Save the changed files and check http://localhost:3000/
Test any visual changes in desktop and mobile viewports
Test if changes meet accessibility standards

Push your changes

git add -A && git commit -m "A title for your changes" to stage and commit your changes
git push your-fork your-feature-branch
Visit github.com/mjhale/blaseball-reference.com and submit a pull request

Dependencies

This is a Next.js project bootstrapped with create-next-app. It uses Chakra UI as a modular component library.

Learn More

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

Next.js Documentation - learn about Next.js features and API.
Learn Next.js - an interactive Next.js tutorial.
Chakra UI Documentation - learn more about Chakra UI components