Skip to content

cp2004/OctoPluginStats

Repository files navigation

OctoPluginStats

Next.js site tracking my OctoPrint plugin statistics over time.

Built using Next.js, Material UI and React, powered by the data at https://data.octoprint.org/export

Want to use this to track your own stats? Feel free!

This site is easily configured to how you would like it. With a little bit of configuration you can get runnning easily!

  1. Fork this repository

  2. Delete the file data/stats.json (delete, not empty) or replace with empty JSON ({}).

  3. Edit the configurationm.js file to your own stuff, including the list of plugin IDs and names.

    ⚠️ All IDs are lowercased by the tracking data scripts, use lowercase IDs here ⚠️

  4. Make sure you have enabled GitHub Actions in the repository settings, they are disabled (by default) for forks.

  5. You can manually trigger the 'Get new data' action.

Deploying to Vercel

Simple! Sign up for an account at https://vercel.com and connect this repository.

Make sure you change the default production branch to deploy:

Deploying to GitHub pages would take a bit more configuration to create the build, but it would be possible. Not investigated yet.

Using these things

  • Material UI V5 (alpha) docs
  • Next.JS

Contributing

Using the above workflow, contributing should be easy. If you have changes you want to make upstream, feel free.

About

Site tracking my OctoPrint plugin statistics over time.

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •