mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
c28c991591
* fix wget command in Readme Fixes https://github.com/inventree/InvenTree/issues/4548 reported by @liuqun * change doc links int markdown * update bash script * Add typing * regenerate script * fix link to contribute * update more links * remove additional whitespace
177 lines
7.5 KiB
Markdown
177 lines
7.5 KiB
Markdown
<div align="center">
|
|
<img src="images/logo/inventree.png" alt="InvenTree logo" width="200" height="auto" />
|
|
<h1>InvenTree</h1>
|
|
<p>Open Source Inventory Management System </p>
|
|
|
|
<!-- Badges -->
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
|
|
|
|
[](https://coveralls.io/github/inventree/InvenTree)
|
|
[](https://crowdin.com/project/inventree)
|
|
|
|
[](https://hub.docker.com/r/inventree/inventree)
|
|
|
|
|
|
[](https://twitter.com/inventreedb)
|
|
[](https://www.reddit.com/r/InvenTree/)
|
|
|
|
|
|
<h4>
|
|
<a href="https://demo.inventree.org/">View Demo</a>
|
|
<span> · </span>
|
|
<a href="https://docs.inventree.org/en/latest/">Documentation</a>
|
|
<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>
|
|
|
|
<!-- About the Project -->
|
|
## :star2: About the Project
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
Powerful business logic works in the background to ensure that stock tracking history is maintained, and users have ready access to stock level information.
|
|
|
|
<!-- Features -->
|
|
|
|
### :dart: Features
|
|
|
|
- Organize Parts and BOMs
|
|
- Manage Suppliers
|
|
- Instant Stock Knowledge
|
|
- Extend and Customize to fit your usage
|
|
|
|
<!-- Roadmap -->
|
|
### :compass: Roadmap
|
|
|
|
* [x] Plugins
|
|
* [ ] Improved Importers
|
|
* [ ] Custom Workflow Processes
|
|
|
|
<!-- Integration -->
|
|
### :hammer_and_wrench: Integration
|
|
|
|
InvenTree is designed to be **extensible**, and provides multiple options for **integration** with external applications or addition of custom plugins:
|
|
|
|
* [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)
|
|
|
|
<!-- 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>
|
|
<li><a href="https://django-allauth.readthedocs.io/">Django-Allauth</a></li>
|
|
</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>
|
|
<li><a href="https://hub.docker.com/r/inventree/inventree">Docker</a></li>
|
|
<li><a href="https://crowdin.com/project/inventree">Crowdin</a></li>
|
|
<li><a href="https://coveralls.io/github/inventree/InvenTree">Coveralls</a></li>
|
|
<li><a href="https://packager.io/gh/inventree/InvenTree">Packager.io</a></li>
|
|
</ul>
|
|
</details>
|
|
|
|
<!-- Getting Started -->
|
|
## :toolbox: Getting Started
|
|
|
|
Refer to the [getting started guide](https://docs.inventree.org/en/latest/start/install/) for installation and setup instructions.
|
|
|
|
<!-- Mobile App -->
|
|
## :iphone: Mobile App
|
|
|
|
InvenTree is supported by a [companion mobile app](https://docs.inventree.org/en/latest/app/app/) which allows users access to stock control information and functionality.
|
|
|
|
<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>
|
|
|
|
<!-- Deploy -->
|
|
## :train: Deploy
|
|
|
|
There are several options to deploy InvenTree.
|
|
|
|
<div align="center"><h4>
|
|
<a href="https://docs.inventree.org/en/latest/start/docker/">Docker</a>
|
|
<span> · </span>
|
|
<a href="https://marketplace.digitalocean.com/apps/inventree?refcode=d6172576d014"><img src="https://www.deploytodo.com/do-btn-blue-ghost.svg" alt="Deploy to DO" width="auto" height="40" /></a>
|
|
<span> · </span>
|
|
<a href="https://docs.inventree.org/en/latest/start/install/">Bare Metal</a>
|
|
</h4></div>
|
|
|
|
Single line install - read [the docs](https://docs.inventree.org/en/latest/start/installer/) for supported distros and details about the function:
|
|
```bash
|
|
wget -qO install.sh https://get.inventree.org && bash install.sh
|
|
```
|
|
|
|
<!-- Contributing -->
|
|
## :wave: Contributing
|
|
|
|
Contributions are welcomed and encouraged. Please help to make this project even better!
|
|
Refer to the [contribution page](CONTRIBUTING.md).
|
|
|
|
<!-- Translation -->
|
|
## :scroll: 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!
|
|
|
|
<!-- Sponsor -->
|
|
## :money_with_wings: Sponsor
|
|
|
|
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)
|
|
|
|
<!-- 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
|
|
|
|
Find a full list of used third-party libraries in [our documentation](https://docs.inventree.org/en/latest/credits/).
|
|
|
|
<!-- License -->
|
|
## :warning: License
|
|
|
|
Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. See [LICENSE.txt](https://github.com/inventree/InvenTree/blob/master/LICENSE) for more information.
|