InvenTree

(β˜… 7,426)

Open Source Inventory Management System

Showing a partial file list β€” download the zip above to see everything.

  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
  • .pkgr.yml
  • .pre-commit-config.yaml
  • AGENTS.md
  • biome.json
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CONTRIBUTING.md
  • crowdin.yml
  • LICENSE
  • Procfile
  • pyproject.toml
  • README.md
  • readthedocs.yml
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/inventree/InvenTree

Downloads the entire project code from GitHub to your computer.

cd InvenTree

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
<li><a href="https://hub.docker.com/r/inventree/inventree">Docker</a></li>

Type this command into your terminal and run it.

<a href="https://docs.inventree.org/en/latest/start/docker/">Docker</a>

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r contrib/container/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation