lilserf / blaseball-reference.com

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

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

Running Locally

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

Contribute

Create a branch

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

Make your changes

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

Push your changes

1. git add -A && git commit -m "A title for your changes" to stage and commit your changes
2. git push your-fork your-feature-branch
3. 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

Project Sponsors

We'd like to thank Vercel, Algolia, and Heap.io for supporting Blaseball Reference as well as the wider open source community.