mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
60e22c50cd
* feat: Add settings for SSO group sync * feat: Handle SSO group sync * fix(SSO): Add default group only if it is the only one When syncing SSO groups on first user creation, the default group should not be added if there is already another group synced by the IdP * docs: Add SSO goup sync instructions * fix: Run pre-commit hooks * i18n(SSO): Wrap settings name and description * docs(SSO): Fix links to allauth docs * fix(frontend): Add SSO_GROUP_KEY option * add unittests for SSO * docs(SSO): Make hint for example comfiguration a tip * docs(SSO): Describe relation between SSO sync and signup group * fix(SSO): Avoid potential key error * feat(SSO): Create mapped group if it does not exist * docs(SSO): Describe how groups can be created during signup --------- Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
190 lines
9.7 KiB
Markdown
190 lines
9.7 KiB
Markdown
<div align="center">
|
|
<img src="assets/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://inventree.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
[](https://bestpractices.coreinfrastructure.org/projects/7179)
|
|
[](https://securityscorecards.dev/viewer/?uri=github.com/inventree/InvenTree)
|
|
[](https://app.netlify.com/sites/inventree/deploys)
|
|
[](https://sonarcloud.io/summary/new_code?id=inventree_InvenTree)
|
|
|
|
[](https://codecov.io/gh/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. A powerful plugin system provides support for custom applications and extensions.
|
|
|
|
Check out [our website](https://inventree.org) for more details.
|
|
|
|
<!-- Roadmap -->
|
|
### :compass: Roadmap
|
|
|
|
Want to see what we are working on? Check out the [roadmap tag](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap) and [horizon milestone](https://github.com/inventree/InvenTree/milestone/42).
|
|
|
|
<!-- 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://docs.allauth.org/">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://app.codecov.io/gh/inventree/InvenTree">Codecov</a></li>
|
|
<li><a href="https://app.deepsource.com/gh/inventree/InvenTree">DeepSource</a></li>
|
|
<li><a href="https://packager.io/gh/inventree/InvenTree">Packager.io</a></li>
|
|
</ul>
|
|
</details>
|
|
|
|
<!-- Getting Started -->
|
|
## :toolbox: Deployment / Getting Started
|
|
|
|
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://inventree.org/digitalocean"><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
|
|
```
|
|
|
|
Refer to the [getting started guide](https://docs.inventree.org/en/latest/start/install/) for a full set of installation and setup instructions.
|
|
|
|
<!-- Mobile App -->
|
|
## :iphone: Mobile App
|
|
|
|
InvenTree is supported by a [companion mobile app](https://docs.inventree.org/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>
|
|
|
|
<!-- 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**.
|
|
|
|
<!-- Sponsor -->
|
|
## :money_with_wings: Sponsor
|
|
|
|
If you use InvenTree and find it to be useful, please consider [sponsoring the project](https://github.com/sponsors/inventree).
|
|
|
|
<!-- 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/).
|
|
|
|
## :heart: Support
|
|
|
|
<p>This project is supported by the following sponsors:</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/MartinLoeper"><img src="https://github.com/MartinLoeper.png" width="60px" alt="Martin Löper" /></a>
|
|
<a href="https://github.com/lippoliv"><img src="https://github.com/lippoliv.png" width="60px" alt="Oliver Lippert" /></a>
|
|
<a href="https://github.com/lfg-seth"><img src="https://github.com/lfg-seth.png" width="60px" alt="Seth Smith" /></a>
|
|
<a href="https://github.com/snorkrat"><img src="https://github.com/snorkrat.png" width="60px" alt="" /></a>
|
|
<a href="https://github.com/spacequest-ltd"><img src="https://github.com/spacequest-ltd.png" width="60px" alt="SpaceQuest Ltd" /></a>
|
|
<a href="https://github.com/appwrite"><img src="https://github.com/appwrite.png" width="60px" alt="Appwrite" /></a>
|
|
<a href="https://github.com/PricelessToolkit"><img src="https://github.com/PricelessToolkit.png" width="60px" alt="" /></a>
|
|
<a href="https://github.com/cabottech"><img src="https://github.com/cabottech.png" width="60px" alt="Cabot Technologies" /></a>
|
|
<a href="https://github.com/markus-k"><img src="https://github.com/markus-k.png" width="60px" alt="Markus Kasten" /></a>
|
|
<a href="https://github.com/jefffhaynes"><img src="https://github.com/jefffhaynes.png" width="60px" alt="Jess Haynes" /></a>
|
|
</p>
|
|
|
|
<p>With ongoing resources provided by:</p>
|
|
|
|
<p align="center">
|
|
<a href="https://inventree.org/digitalocean">
|
|
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px" alt="Servers by Digital Ocean">
|
|
</a>
|
|
<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" /> </a>
|
|
<a href="https://crowdin.com"> <img src="https://crowdin.com/images/crowdin-logo.svg" alt="Translation by Crowdin" /> </a>
|
|
</p>
|
|
|
|
|
|
<!-- 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.
|