Skip to content

Plugin Walkthrough #9400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

RedEchidnaUK
Copy link

This PR adds walkthrough documentation for building an Inventree part plugin panel.

I've created it around a basic example that (hopefully) helps guide the reader on how to do some things,

  • Setup a build environment using the Plugin Creator
  • Test the build environment
  • Create a basic panel
  • Query Inventree via the frontend
  • Query Inventree via the backend
  • Pass data from the backend to the frontend
  • Create panel admin settings
  • Add custom styling

I would be highly surprised if this PR is 100% correct first time, so please do provide feedback on what you think works or doesn't work and I'll look at changing it. Lastly, I'm not a professional software developer, which means I might well be doing something that isn't best practice and although this is far from a Python/React tutorial it would be nice not to make obvious mistakes. Again, feel free to point out those mistakes.

Copy link

netlify bot commented Mar 27, 2025

Deploy Preview for inventree-web-pui-preview canceled.

Name Link
🔨 Latest commit 7aa6011
🔍 Latest deploy log https://app.netlify.com/projects/inventree-web-pui-preview/deploys/68474f431bdc580008ab3d19

@matmair
Copy link
Contributor

matmair commented Apr 1, 2025

Thank you for submitting this @RedEchidnaUK ! I will try to give it a thorough review within the next 7 days

@RedEchidnaUK
Copy link
Author

Thanks @matmair for the update. Appreciate you taking the time.

@matmair matmair added plugin Plugin ecosystem documentation labels Jun 9, 2025
@matmair matmair added this to the 1.0.0 milestone Jun 9, 2025
@SchrodingersGat
Copy link
Member

@RedEchidnaUK this is looking good! Two small suggestions, both to improve discoverability of this walkthrough

  1. Add the new page to the index in "mkdocs.yml"
  2. Add a link and description to the walkthrough on the "plugins/index" page

@RedEchidnaUK
Copy link
Author

Thanks @SchrodingersGat I’ll try and take a look at this later this week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation plugin Plugin ecosystem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants