Repository files navigation

Inventory without a catch, and all the hooks

Open Quartermaster is an open source inventory management system, designed to be simple to use yet powerful and extendable. The last inventory management system you will ever need!

We are very much in development still, so check back often! We are also accepting any and all assistance, so feel free to report issues or feature requests, as well as pull requests! Additionally, feel free to ask questions in theDiscussions or just hang out with us on ourDiscord

• For a quick start running on your own computer, check outSingle Host Deployment
• To see all the ways you can deploy OQM for yourself, seeDeployment

C4Contexttitle System Context diagram for Open QuarterMasterPerson(user, "User", "You (Hopefully)!")System_Boundary(b1, "Deployment Environment- Local computer/server, Kubernetes") {  SystemDb_Ext(baseStation, "OQM Base Station", "Handles all Inventory Management core functionality")  System(stationCaptain, "Station Captain", "Manages your installation (On single server only)")  Boundary(boundaryInfra, "Infrastructure Components") {    SystemDb(mongo, "MongoDB")    SystemDb(amq, "AMQ")    System(jaeger, "Jaeger")  }    Boundary(boundaryPlugins, "Plugins") {    System(pluginPoc, "Point of Sale (Planned)", "Standard POS functions")    System(pluginStorage, "Interactive and Modular Storage (Planned)", "A system that intractis with physical storage medims to help convey placement of items.")  }}

Please use the diagram above for reference.

How we accomplish the goal of being the only inventory management system you could ever need is through our modular design. The main component of Open QuarterMaster is theCore API. Think of this as the central hub and core functionality of the system. It handles all the generic inventory management tasks; what is stored where, and facts about what is stored. This central component is designed to be, on the whole, generic and accessible. We also have a frontend for the core API called theBase Station, which lets you have direct and easy to navigate access to your inventory.

To cover specific use-cases, we have what we callPlugins. These are components that extend the functionality of the basic inventory management, and fill additional needs with their own capabilities. Examples could include Smart Refrigerator integrations, a system for interacting with physical storage mediums, Point of Sale Systems, Workflow management.. the list is endless. You could even create your own!

In the theme of flexibility, the system is designed to be run in many different environments. It is just as home on the cloud as well as something as small as aRaspberry Pi. This is accomplished using containers, segmenting each software component, ensuring flexibility and ease of management.

To get started on your own hardware, please seeSingle Host Deployment

Being an open initiative, we take great care to ensure you are in control of your own data. None of the software we include here phones home at all, with the brief exception of Station Captain, which looks to this Git repository for installations and updates. If you have a simple setup on your own hardware, you can expect your data to stay with you, and not transmitted anywhere by the software we include here.

Thanks goes to these wonderful people (emoji key):

Greg Stewart 🐛💼💻🖋🔣📖🎨🤔🚇🚧📆🔧⚠️	Anthony Nixon 🚇🧑‍🏫	kfrankli 📖	ajoline 🧑‍🏫👀🛡️	piercde12 💼🖋📖🎨⚠️📓	Kyle Clark 🖋🤔🧑‍🏫👀🛡️⚠️📓	DanielKrejska 💻
LouisBarbier 🖋📆	Brendan Andrews 💻	Spitzer-Tech 🐛🎨💡💵⚠️📓🤔	steve-dill 🐛💻🤔🚇🧑‍🏫🔧📓🚧	mulliar22 💻🔣📖💡🔌🔬	mallom21 💻🔣📖💡🔌🔬📆	Coletrane315 💻🔣📖💡🔌🔬

This project follows theall-contributors specification. Contributions of any kind welcome!