InvenTree/README.md

36 lines
2.3 KiB
Markdown
Raw Normal View History

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/inventree/InvenTree.svg?branch=master)](https://travis-ci.org/inventree/InvenTree) [![Documentation Status](https://readthedocs.org/projects/inventree/badge/?version=latest)](https://inventree.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://coveralls.io/repos/github/inventree/InvenTree/badge.svg)](https://coveralls.io/github/inventree/InvenTree)
2017-03-23 23:55:24 +00:00
2019-08-15 12:01:57 +00:00
<img src="images/logo/inventree.png" alt="InvenTree" width="128"/>
# InvenTree
2017-04-11 07:36:51 +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 JSON API for interaction with external interfaces and applications.
2019-05-09 21:40:08 +00:00
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.
2019-05-09 21:40:08 +00:00
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.
## Getting Started
Refer to the [getting started guide](https://inventree.github.io/docs/start/install) for installation and setup instructions.
## Documentation
For InvenTree documentation, refer to the [InvenTre documentation website](https://inventree.github.io).
2020-05-12 12:13:50 +00:00
## 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.github.io/docs/extend/api)
* [Python module](https://inventree.github.io/docs/extend/python)
* [Plugin interface](https://inventree.github.io/docs/extend/plugins)
* [Third party](https://inventree.github.io/docs/extend/integrate)
## Developer Documentation
For code documentation, refer to the [developer documentation](http://inventree.readthedocs.io/en/latest/).
## Contributing
Contributions are welcomed and encouraged. Please help to make this project even better! Refer to the [contribution page](https://inventree.github.io/pages/contribute).