mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
80 lines
5.6 KiB
Markdown
80 lines
5.6 KiB
Markdown
|
|
<img src="images/logo/inventree.png" alt="InvenTree" width="128"/>
|
|
|
|
# InvenTree
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://coveralls.io/github/inventree/InvenTree)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
InvenTree is an open-source Inventory Management System which provides powerful low-level stock control and part tracking. The core of the InvenTree system is a Python/Django database backend which provides an admin interface (web-based) and a JSON API for interaction with external interfaces and applications.
|
|
|
|
InvenTree is designed to be lightweight and easy to use for SME or hobbyist applications, where many existing stock management solutions are bloated and cumbersome to use. Updating stock is a single-action process and does not require a complex system of work orders or stock transactions.
|
|
|
|
However, powerful business logic works in the background to ensure that stock tracking history is maintained, and users have ready access to stock level information.
|
|
|
|
# Docker
|
|
|
|
[](https://hub.docker.com/r/inventree/inventree)
|
|
|
|
|
|
InvenTree is [available via Docker](https://hub.docker.com/r/inventree/inventree). Read the [docker guide](https://inventree.readthedocs.io/en/latest/start/docker/) for full details.
|
|
|
|
# Companion App
|
|
|
|
InvenTree is supported by a [companion mobile app](https://inventree.readthedocs.io/en/latest/app/app/) which allows users access to stock control information and functionality.
|
|
|
|
[**Download InvenTree from the Android Play Store**](https://play.google.com/store/apps/details?id=inventree.inventree_app)
|
|
|
|
*Currently the mobile app is only availble for Android*
|
|
|
|
# Translation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Native language translation of the InvenTree web application is [community contributed via crowdin](https://crowdin.com/project/inventree). **Contributions are welcomed and encouraged**.
|
|
|
|
To contribute to the translation effort, navigate to the [InvenTree crowdin project](https://crowdin.com/project/inventree), create a free account, and start making translations suggestions for your language of choice!
|
|
|
|
# Documentation
|
|
|
|
For InvenTree documentation, refer to the [InvenTree documentation website](https://inventree.readthedocs.io/en/latest/).
|
|
|
|
# Credits
|
|
|
|
The credits for all used packages are part of the [InvenTree documentation website](https://inventree.readthedocs.io/en/latest/credits/).
|
|
|
|
## Getting Started
|
|
|
|
Refer to the [getting started guide](https://inventree.readthedocs.io/en/latest/start/install/) for installation and setup instructions.
|
|
|
|
## Integration
|
|
|
|
InvenTree is designed to be extensible, and provides multiple options for integration with external applications or addition of custom plugins:
|
|
|
|
* [InvenTree API](https://inventree.readthedocs.io/en/latest/extend/api/)
|
|
* [Python module](https://inventree.readthedocs.io/en/latest/extend/python)
|
|
* [Plugin interface](https://inventree.readthedocs.io/en/latest/extend/plugins)
|
|
* [Third party](https://inventree.readthedocs.io/en/latest/extend/integrate)
|
|
|
|
# Contributing
|
|
|
|
Contributions are welcomed and encouraged. Please help to make this project even better! Refer to the [contribution page](https://inventree.readthedocs.io/en/latest/contribute/).
|
|
|
|
# Donate
|
|
|
|
If you use InvenTree and find it to be useful, please consider making a donation toward its continued development.
|
|
|
|
[Donate via PayPal](https://paypal.me/inventree?locale.x=en_AU)
|