2022-05-01 23:46:06 +00:00
< div align = "center" >
2024-04-03 01:16:59 +00:00
< img src = "assets/images/logo/inventree.png" alt = "InvenTree logo" width = "200" height = "auto" / >
2022-05-01 23:46:06 +00:00
< h1 > InvenTree< / h1 >
< p > Open Source Inventory Management System < / p >
2021-04-21 12:04:46 +00:00
2022-05-01 23:46:06 +00:00
<!-- Badges -->
[](https://opensource.org/licenses/MIT)
2023-04-22 14:20:41 +00:00
[](https://inventree.readthedocs.io/en/latest/?badge=latest)
2022-05-29 07:41:14 +00:00
2023-06-03 14:47:06 +00:00
[](https://bestpractices.coreinfrastructure.org/projects/7179)
2024-03-24 22:12:49 +00:00
[](https://securityscorecards.dev/viewer/?uri=github.com/inventree/InvenTree)
2023-07-27 01:17:44 +00:00
[](https://app.netlify.com/sites/inventree/deploys)
2024-04-02 06:35:01 +00:00
[](https://sonarcloud.io/summary/new_code?id=inventree_InvenTree)
2021-04-21 12:04:46 +00:00
2024-04-07 21:33:26 +00:00
[](https://codecov.io/gh/inventree/InvenTree)
2021-11-21 11:15:49 +00:00
[](https://crowdin.com/project/inventree)
2022-05-01 23:46:06 +00:00
[](https://hub.docker.com/r/inventree/inventree)
2019-08-15 12:01:57 +00:00
2022-05-01 23:46:06 +00:00
2022-05-09 10:49:46 +00:00
[](https://twitter.com/inventreedb)
[](https://www.reddit.com/r/InvenTree/)
2017-04-11 07:36:51 +00:00
2019-04-27 22:39:41 +00:00
2022-05-01 23:46:06 +00:00
< h4 >
< a href = "https://demo.inventree.org/" > View Demo< / a >
< span > · < / span >
2023-04-01 21:34:53 +00:00
< a href = "https://docs.inventree.org/en/latest/" > Documentation< / a >
2022-05-01 23:46:06 +00:00
< span > · < / span >
< a href = "https://github.com/inventree/InvenTree/issues/new?template=bug_report.md&title=[BUG]" > Report Bug< / a >
< span > · < / span >
< a href = "https://github.com/inventree/InvenTree/issues/new?template=feature_request.md&title=[FR]" > Request Feature< / a >
< / h4 >
< / div >
2019-04-27 22:39:41 +00:00
2022-05-01 23:46:06 +00:00
<!-- About the Project -->
## :star2: About the Project
2021-11-10 21:39:28 +00:00
2023-06-21 12:30:30 +00:00
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 REST API for interaction with external interfaces and applications. A powerful plugin system provides support for custom applications and extensions.
2021-11-10 21:39:28 +00:00
2023-06-21 12:30:30 +00:00
Check out [our website ](https://inventree.org ) for more details.
2021-03-01 03:49:13 +00:00
2022-05-01 23:46:06 +00:00
<!-- Roadmap -->
### :compass: Roadmap
2021-03-01 03:49:13 +00:00
2023-06-21 12:30:30 +00:00
Want to see what we are working on? Check out the [roadmap tag ](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap ) and [horizon milestone ](https://github.com/inventree/InvenTree/milestone/42 ).
2022-02-26 22:10:55 +00:00
2022-05-01 23:46:06 +00:00
<!-- Integration -->
### :hammer_and_wrench: Integration
2019-04-27 22:39:41 +00:00
2022-05-01 23:46:06 +00:00
InvenTree is designed to be **extensible** , and provides multiple options for **integration** with external applications or addition of custom plugins:
2019-04-27 22:39:41 +00:00
2023-04-01 21:34:53 +00:00
* [InvenTree API ](https://docs.inventree.org/en/latest/api/api/ )
* [Python module ](https://docs.inventree.org/en/latest/api/python/python/ )
* [Plugin interface ](https://docs.inventree.org/en/latest/extend/plugins )
* [Third party tools ](https://docs.inventree.org/en/latest/extend/integrate )
2022-05-01 23:46:06 +00:00
<!-- TechStack -->
### :space_invader: Tech Stack
< details >
< summary > Server< / summary >
< ul >
< li > < a href = "https://www.python.org/" > Python< / a > < / li >
< li > < a href = "https://www.djangoproject.com/" > Django< / a > < / li >
< li > < a href = "https://www.django-rest-framework.org/" > DRF< / a > < / li >
< li > < a href = "https://django-q.readthedocs.io/" > Django Q< / a > < / li >
2024-06-29 10:32:28 +00:00
< li > < a href = "https://docs.allauth.org/" > Django-Allauth< / a > < / li >
2022-05-01 23:46:06 +00:00
< / ul >
< / details >
< details >
< summary > Database< / summary >
< ul >
< li > < a href = "https://www.postgresql.org/" > PostgreSQL< / a > < / li >
< li > < a href = "https://www.mysql.com/" > MySQL< / a > < / li >
< li > < a href = "https://www.sqlite.org/" > SQLite< / a > < / li >
< li > < a href = "https://redis.io/" > Redis< / a > < / li >
< / ul >
< / details >
< details >
< summary > Client< / summary >
< ul >
< li > < a href = "https://getbootstrap.com/" > Bootstrap< / a > < / li >
< li > < a href = "https://jquery.com/" > jQuery< / a > < / li >
< li > < a href = "https://bootstrap-table.com/" > Bootstrap-Table< / a > < / li >
< / ul >
< / details >
< details >
< summary > DevOps< / summary >
< ul >
2022-08-15 21:55:39 +00:00
< li > < a href = "https://hub.docker.com/r/inventree/inventree" > Docker< / a > < / li >
< li > < a href = "https://crowdin.com/project/inventree" > Crowdin< / a > < / li >
2024-04-22 22:42:31 +00:00
< li > < a href = "https://app.codecov.io/gh/inventree/InvenTree" > Codecov< / a > < / li >
2023-10-17 00:23:19 +00:00
< li > < a href = "https://app.deepsource.com/gh/inventree/InvenTree" > DeepSource< / a > < / li >
2022-10-23 22:48:59 +00:00
< li > < a href = "https://packager.io/gh/inventree/InvenTree" > Packager.io< / a > < / li >
2022-05-01 23:46:06 +00:00
< / ul >
< / details >
<!-- Getting Started -->
2023-06-21 12:30:30 +00:00
## :toolbox: Deployment / Getting Started
2020-05-12 12:13:50 +00:00
2022-05-01 23:46:06 +00:00
There are several options to deploy InvenTree.
2019-12-20 03:23:06 +00:00
2022-05-01 23:46:06 +00:00
< div align = "center" > < h4 >
2023-04-01 21:34:53 +00:00
< a href = "https://docs.inventree.org/en/latest/start/docker/" > Docker< / a >
2022-05-01 23:46:06 +00:00
< span > · < / span >
2023-05-01 17:42:14 +00:00
< a href = "https://inventree.org/digitalocean" > < img src = "https://www.deploytodo.com/do-btn-blue-ghost.svg" alt = "Deploy to DO" width = "auto" height = "40" / > < / a >
2022-11-25 01:24:24 +00:00
< span > · < / span >
2023-04-01 21:34:53 +00:00
< a href = "https://docs.inventree.org/en/latest/start/install/" > Bare Metal< / a >
2022-05-01 23:46:06 +00:00
< / h4 > < / div >
2019-12-20 03:23:06 +00:00
2023-04-01 21:34:53 +00:00
Single line install - read [the docs ](https://docs.inventree.org/en/latest/start/installer/ ) for supported distros and details about the function:
2022-10-15 23:14:18 +00:00
```bash
2023-04-01 21:34:53 +00:00
wget -qO install.sh https://get.inventree.org & & bash install.sh
2022-10-15 23:14:18 +00:00
```
2023-06-21 12:30:30 +00:00
Refer to the [getting started guide ](https://docs.inventree.org/en/latest/start/install/ ) for a full set of installation and setup instructions.
<!-- Mobile App -->
## :iphone: Mobile App
2024-05-31 07:06:12 +00:00
InvenTree is supported by a [companion mobile app ](https://docs.inventree.org/app/ ) which allows users access to stock control information and functionality.
2023-06-21 12:30:30 +00:00
< div align = "center" > < h4 >
< a href = "https://play.google.com/store/apps/details?id=inventree.inventree_app" > Android Play Store< / a >
< span > · < / span >
< a href = "https://apps.apple.com/au/app/inventree/id1581731101#?platform=iphone" > Apple App Store< / a >
< / h4 > < / div >
2022-05-01 23:46:06 +00:00
<!-- Contributing -->
## :wave: Contributing
2020-05-20 00:45:43 +00:00
2023-06-21 12:30:30 +00:00
Contributions are welcomed and encouraged. Please help to make this project even better! Refer to the [contribution page ](CONTRIBUTING.md ).
2022-05-01 23:46:06 +00:00
<!-- Translation -->
## :scroll: Translation
2022-02-08 20:56:31 +00:00
Native language translation of the InvenTree web application is [community contributed via crowdin ](https://crowdin.com/project/inventree ). **Contributions are welcomed and encouraged** .
2022-05-01 23:46:06 +00:00
<!-- Sponsor -->
## :money_with_wings: Sponsor
2020-05-20 00:45:43 +00:00
2023-06-21 12:30:30 +00:00
If you use InvenTree and find it to be useful, please consider [sponsoring the project ](https://github.com/sponsors/inventree ).
2022-05-01 23:46:06 +00:00
<!-- Acknowledgments -->
## :gem: Acknowledgements
We would like to acknowledge a few special projects:
- [PartKeepr ](https://github.com/partkeepr/PartKeepr ) as a valuable predecessor and inspiration
- [Readme Template ](https://github.com/Louis3797/awesome-readme-template ) for the template of this page
2023-04-01 21:34:53 +00:00
Find a full list of used third-party libraries in [our documentation ](https://docs.inventree.org/en/latest/credits/ ).
2022-05-01 23:46:06 +00:00
2023-10-26 06:35:18 +00:00
## :heart: Support
< p > This project is supported by the following sponsors:< / p >
< p align = "center" >
2024-01-10 13:45:22 +00:00
< a href = "https://github.com/MartinLoeper" > < img src = "https://github.com/MartinLoeper.png" width = "60px" alt = "Martin Löper" / > < / a >
< a href = "https://github.com/lippoliv" > < img src = "https://github.com/lippoliv.png" width = "60px" alt = "Oliver Lippert" / > < / a >
< a href = "https://github.com/lfg-seth" > < img src = "https://github.com/lfg-seth.png" width = "60px" alt = "Seth Smith" / > < / a >
< a href = "https://github.com/snorkrat" > < img src = "https://github.com/snorkrat.png" width = "60px" alt = "" / > < / a >
< a href = "https://github.com/spacequest-ltd" > < img src = "https://github.com/spacequest-ltd.png" width = "60px" alt = "SpaceQuest Ltd" / > < / a >
< a href = "https://github.com/appwrite" > < img src = "https://github.com/appwrite.png" width = "60px" alt = "Appwrite" / > < / a >
< a href = "https://github.com/PricelessToolkit" > < img src = "https://github.com/PricelessToolkit.png" width = "60px" alt = "" / > < / a >
< a href = "https://github.com/cabottech" > < img src = "https://github.com/cabottech.png" width = "60px" alt = "Cabot Technologies" / > < / a >
2024-01-17 22:37:54 +00:00
< a href = "https://github.com/markus-k" > < img src = "https://github.com/markus-k.png" width = "60px" alt = "Markus Kasten" / > < / a >
2024-02-25 22:50:42 +00:00
< a href = "https://github.com/jefffhaynes" > < img src = "https://github.com/jefffhaynes.png" width = "60px" alt = "Jess Haynes" / > < / a >
2023-10-26 06:35:18 +00:00
< / p >
< p > With ongoing resources provided by:< / p >
< p align = "center" >
2023-05-01 17:42:14 +00:00
< a href = "https://inventree.org/digitalocean" >
2024-01-10 13:45:22 +00:00
< img src = "https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width = "201px" alt = "Servers by Digital Ocean" >
2023-05-01 17:42:14 +00:00
< / a >
2023-07-27 01:17:44 +00:00
< a href = "https://www.netlify.com" > < img src = "https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt = "Deploys by Netlify" / > < / a >
2024-01-10 13:45:22 +00:00
< a href = "https://crowdin.com" > < img src = "https://crowdin.com/images/crowdin-logo.svg" alt = "Translation by Crowdin" / > < / a >
2023-05-01 17:42:14 +00:00
< / p >
2023-07-27 01:17:44 +00:00
2022-05-01 23:46:06 +00:00
<!-- License -->
## :warning: License
2022-05-09 10:04:45 +00:00
Distributed under the [MIT ](https://choosealicense.com/licenses/mit/ ) License. See [LICENSE.txt ](https://github.com/inventree/InvenTree/blob/master/LICENSE ) for more information.
