๐ŸŽฎ๐ŸŽฏ Quickly check which tier is any character in Super Smash Bros. series
Switch branches/tags
Nothing to show
Clone or download

README.md

Super Smash Bros Ball

๐ŸŽฎ ๐ŸŽฏ Smash Tier List ย 

Build Status Coverage Status

See it online โ†—

An Open Source Tier List application that covers all characters in Super Smash Bros game series with UX and performance in mind. Built on top of React and proudly hosted on Netlify.

ย 

๐Ÿ’Ž SketchApp Design

Desktop HD - Mockup vs Screenshot

sketchapp - desktop hd - ssb4 actual - desktop hd - ssb4

Mobile - Mockup vs Screenshot

sketchapp - mobile - ssb4 actual - mobile - ssb4

๐ŸŽฌ Getting Started

Installation

$ yarn
$ cp .env.example .env

Note: while it's not required in order to run it locally in dev mode, it is important to define your own S3 bucket data in .env to be able to deploy assets to S3.

Development server

$ yarn start

Then you should be able to open a browser at http://localhost:3000 and see the application.

โœ… Syntax check and tests

Run ESLint

$ yarn eslint

Run tests

$ yarn test

Generate coverage

$ yarn coverage

๐Ÿ›  Building the project

Make a production build to run it locally

$ yarn stage
$ yarn serve

Note: if you use stage:s3 instead of stage, all the assets that have been processed by webpack are deployed into the S3 bucket right away.

Make a definitive production build

$ yarn build

Note: again, you can use build:s3 instead of build and compiled assets are sent to the S3 bucket.