From 9022bd327087b953b7415034c55d49b1e1ec4878 Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 2 May 2022 01:46:06 +0200 Subject: [PATCH 1/2] Add new readme --- README.md | 192 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 145 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index dd76fd41dd..9eb6229d46 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,176 @@ +
+ InvenTree logo +

InvenTree

+

Open Source Inventory Management System

-InvenTree - -# InvenTree - -

- follow on Twitter

- -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![Coverage Status](https://coveralls.io/repos/github/inventree/InvenTree/badge.svg)](https://coveralls.io/github/inventree/InvenTree) -[![Crowdin](https://badges.crowdin.net/inventree/localized.svg)](https://crowdin.com/project/inventree) + +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/inventree/inventree) ![CI](https://github.com/inventree/inventree/actions/workflows/qc_checks.yaml/badge.svg) +![Docker Build](https://github.com/inventree/inventree/actions/workflows/docker_latest.yaml/badge.svg) + +![Coveralls](https://img.shields.io/coveralls/github/inventree/InvenTree) +[![Crowdin](https://badges.crowdin.net/inventree/localized.svg)](https://crowdin.com/project/inventree) +![Lines of code](https://img.shields.io/tokei/lines/github/inventree/InvenTree) +![GitHub commit activity](https://img.shields.io/github/commit-activity/m/inventree/inventree) +![PyPI - Downloads](https://img.shields.io/pypi/dm/inventree) +[![Docker Pulls](https://img.shields.io/docker/pulls/inventree/inventree)](https://hub.docker.com/r/inventree/inventree) + +![GitHub Org's stars](https://img.shields.io/github/stars/inventree?style=social) +![Twitter Follow](https://img.shields.io/twitter/follow/inventreedb?style=social) +![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/inventree?style=social) + + +

+ View Demo + · + Documentation + · + Report Bug + · + Request Feature +

+
+ + +## :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. +
+ screenshot +
+ 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. -# Demo + -A demo instance of InvenTree is provided to allow users to explore the functionality of the software. [Read more here](https://inventree.readthedocs.io/en/latest/demo/) +### :dart: Features -# Docker +- Organize Parts and BOMs +- Manage Suppliers +- Instant Stock Knowledge +- Extend and Customize to fit your usage -[![Docker Pulls](https://img.shields.io/docker/pulls/inventree/inventree)](https://hub.docker.com/r/inventree/inventree) -![Docker Build](https://github.com/inventree/inventree/actions/workflows/docker_latest.yaml/badge.svg) + +### :compass: Roadmap -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. +* [x] Plugins +* [ ] Improved Importers +* [ ] Custom Workflow Processes -# Mobile App + +### :hammer_and_wrench: Integration -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) - -- [**Download InvenTree from the Apple App Store**](https://apps.apple.com/au/app/inventree/id1581731101#?platform=iphone) - -# Deploy to DigitalOcean -[![Deploy to DO](https://www.deploytodo.com/do-btn-blue-ghost.svg)](https://marketplace.digitalocean.com/apps/inventree?refcode=d6172576d014) - -# Documentation - -For InvenTree documentation, refer to the [InvenTree documentation website](https://inventree.readthedocs.io/en/latest/). - -# Getting Started - -Refer to the [getting started guide](https://inventree.readthedocs.io/en/latest/start/install/) for installation and setup instructions. - -# Credits - -The credits for all used packages are part of the [InvenTree documentation website](https://inventree.readthedocs.io/en/latest/credits/). - -# Integration - -InvenTree is designed to be extensible, and provides multiple options for integration with external applications or addition of custom plugins: +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) +* [Third party tools](https://inventree.readthedocs.io/en/latest/extend/integrate) -# Contributing + +### :space_invader: Tech Stack -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/). +
+ Server + +
-# Translation +
+Database + +
+ +
+ Client + +
+ +
+DevOps + +
+ + +## :toolbox: Getting Started + +Refer to the [getting started guide](https://inventree.readthedocs.io/en/latest/start/install/) for installation and setup instructions. + + +## :iphone: Mobile 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. + +

+ Android Play Store + · + Apple App Store +

+ + +## :train: Deploy + +There are several options to deploy InvenTree. + +

+ Docker + · + Deploy to DO + · + Bare Metal +

+ + +## :wave: Contributing + +Contributions are welcomed and encouraged. Please help to make this project even better! +Refer to the [contribution page in the docs ](https://inventree.readthedocs.io/en/latest/contribute/) and check out [contributing.md](CONTRIBUTING.md). + + +## :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! -# Donate + +## :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) + + +## :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://inventree.readthedocs.io/en/latest/credits/). + + +## :warning: License + +Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. See LICENSE.txt for more information. From 33a7d98dff5bef4ef29887a554fad1a97504408f Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 2 May 2022 21:12:11 +0200 Subject: [PATCH 2/2] remove screenshot it is difficult to find the single thing that descirbes InvenTree --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 9eb6229d46..a499ce8856 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,6 @@ 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. -
- screenshot -
- 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.