Skip to content

Corncycle/ultimate-stage-data-server

Repository files navigation

ultimate-stage-data-server

Preview of Ultimate Stage Data website

Live: https://ultimatestagedata.com

A web application serving stage-dependent statistics of character and matchup win rates from Smash Ultimate tournaments.

Sets are queried from start.gg's GraphQL API, processed by the server, and stored in a separate database. Data is updated on the server-side each Friday.

Running this project locally

To run this project locally, clone this repository, navigate to your local copy and run npm install to install required dependencies. To run the server, in a command line run

npm run dev

The server will be accessible on localhost:3000, and will reload upon saved file changes.

NOTE: Running this server locally requires two environment variables to be set. START_GG_API_KEY must be set to a valid start.gg API key and MONGODB_CONNECTION_STRING must be set to a connection string for a MongoDB Atlas database that allows reads and writes.

To run code snippets testing various utility scripts (like those in /misc-data/exampleApiCalls.js), edit sandbox.js to your liking and run

npm run sandbox

Updating and restarting a fly.io server running this application

This section is mostly a reminder for myself. This repository does not include guidance for deploying to fly, and these commands will only work if you deploy to fly with a project name identical to the one I chose.

To deploy a new version of the server, run

flyctl deploy

To restart a live server, run

flyctl apps restart ultimate-stage-data

About

Stage-specific Smash Ultimate tournament statistics

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published