Code Monkey home page Code Monkey logo

plugins-dashboard's Introduction

thelastWallE OctoPrint Plugins Dashboard

This is the source for https://thelastWallE.github.io/plugins-dashboard .

It uses NodeJS, React, Material-UI, Recharts and Gatsby. The site is built from the gh-pages branch and copied to the main branch where it is served using github pages.

Setup Your Own Dashboard

You can use this to track your own plugins!

  1. Fork https://github.com/The-EG/plugins-dashboard repo
  2. In branch the-eg, replace the contents of each .json file in data/ with an empty object ({})
  3. Update plugins-dashboard-config.json
  4. Setup a personal access token:
    1. Go to your user settings
    2. Go to 'developer' settings
    3. Go to 'personal access tokens'
    4. Click generate new token, give it a name, etc. Give it 'public_repo' access.
    5. Copy the new token
  5. Add the token as a repo secret
    1. Go to the newly forked repo settings
    2. Go to 'Secrets'
    3. 'New Repository Secret' named REPO_TOKEN and paste the token you copied above
  6. (Optional) rename the the-eg branch to your own liking.
    1. Update the reference to the above branch in .github/workflows/*.yml (in branch gh-pages)
  7. Enable GH Pages on the main branch
    1. Go to repo settings
    2. Goto 'Pages'
    3. Select the main branch and / (root)
    4. Click save
  8. Manually trigger the 'Update data/*.json' workflow

After that, it should update once a day and automatically deploy.

If I make updates that you'd like to incorporate to your fork later:

  1. Clone your fork locally
  2. Setup this repo as upstream: git remote add upstream https://github.com/The-EG/plugins-dashboard.git
  3. While on your gh-pages branch, pull my gh-pages branch: git pull upstream gh-pages
  4. Push the changes back up to yours: git push
  5. Switch to your data branch, ie the-eg, and merge in gh-pages: git merge gh-pages
  6. Push those changes up too: git push

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.