Merge remote-tracking branch 'inventree/master' into order-parts-wizard

README.md

@@ -1,16 +1,38 @@
+<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>
 
-<img src="images/logo/inventree.png" alt="InvenTree" width="128"/>
+<!-- Badges -->
-
+[![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)
-# InvenTree
-
-<p><a href="https://twitter.com/intent/follow?screen_name=inventreedb">
-        <img src="https://img.shields.io/twitter/follow/inventreedb?style=social&logo=twitter"
-            alt="follow on Twitter"></a></p>
-            
-[![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)
 ![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)
+
+
+<h4>
+    <a href="https://demo.inventree.org/">View Demo</a>
+  <span> · </span>
+    <a href="https://inventree.readthedocs.io/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.
 
@@ -18,61 +40,133 @@ InvenTree is designed to be lightweight and easy to use for SME or hobbyist appl
 
 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
+<!-- Features -->
 
-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)
+<!-- Roadmap -->
-![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
+<!-- Integration -->
+### :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. 
+InvenTree is designed to be **extensible**, and provides multiple options for **integration** with external applications or addition of custom plugins:
-
-- [**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 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
+<!-- TechStack -->
+### :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/).
+<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>
 
-# Translation
+<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://www.docker.com/">Docker</a></li>
+    <li><a href="https://crowdin.com/">Crowdin</a></li>
+    <li><a href="https://coveralls.io/">Coveralls</a></li>
+  </ul>
+</details>
+
+<!-- Getting Started -->
+## 	:toolbox: Getting Started
+
+Refer to the [getting started guide](https://inventree.readthedocs.io/en/latest/start/install/) for installation and setup instructions.
+
+<!-- Mobile App -->
+## 	: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. 
+
+<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://inventree.readthedocs.io/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://inventree.readthedocs.io/en/latest/start/install/">Bare Metal</a>
+</h4></div>
+
+<!-- Contributing -->
+## :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).
+
+<!-- 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!
 
-# Donate
+<!-- 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://inventree.readthedocs.io/en/latest/credits/).
+
+<!-- License -->
+## :warning: License
+
+Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. See LICENSE.txt for more information.