mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
fa480c0558
Add info on Inventree-Docker
27 lines
2.0 KiB
Markdown
27 lines
2.0 KiB
Markdown
[![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)
|
|
|
|
<img src="images/logo/inventree.png" alt="InvenTree" width="128"/>
|
|
|
|
# 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.
|
|
|
|
## User Documentation
|
|
|
|
For InvenTree documentation, refer to the [user documentation](https://inventree.github.io).
|
|
|
|
## Developer Documentation
|
|
|
|
For site administrator and project code documentation, refer to the [developer documentation](http://inventree.readthedocs.io/en/latest/). This includes auto-generated documentation of the InvenTree python codebase.
|
|
|
|
## Getting Started
|
|
|
|
Refer to the [getting started guide](https://inventree.readthedocs.io/en/latest/start.html) for installation and setup instructions.
|
|
|
|
### Third Party
|
|
|
|
[InvenTree Docker](https://github.com/Zeigren/inventree-docker) - A docker build for InvenTree by [Zeigren](https://github.com/Zeigren)
|