inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-05-04 16:38:56 +00:00
Code

Merge pull request from 42CrMo4/patch-1

Browse Source 
Update install.md
This commit is contained in:
Oliver 2021-03-19 22:18:34 +11:00 committed by GitHub
commit 2f13a5bec1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 18 deletions

46
docs/start/install.md

@ -66,6 +66,24 @@ pkg install py37-wheel
pkg install py37-invoke
```
## Download Source Code
Download the InvenTree source code to a local directory. It is recommended to perform this step using git, as this allows the InvenTree installation to be easily updated to the latest version.
```
git clone https://github.com/inventree/inventree/
```
Alternatively, the source can be downloaded as a [.zip archive](https://github.com/inventree/InvenTree/archive/master.zip).
Once the source is downloaded, cd into the source directory:
```
cd /path/to/inventree/
```
*(substitute /path/to/inventree/ with the directory where you have downloaded the source code)*.
## Python Setup
To install InvenTree you will need python3 (>3.6) installed, as well as PIP (the Python package manager), and the Invoke tool.
@ -87,6 +105,16 @@ python3 -m venv inventree-env
source inventree-env/bin/activate
```
!!! note "Activate Virtual Environment"
if
```
source inventree-env/bin/activate
```
is not working try
```
. inventree-env/bin/activate
```
!!! note "Virtual Environment on Windows"
To create and activate a virtual environment in Windows, run the following commands:
```
@ -120,24 +148,6 @@ To display a list of the available configuration scripts, run the following comm
inv --list
```
## Download Source Code
Download the InvenTree source code to a local directory. It is recommended to perform this step using git, as this allows the InvenTree installation to be easily updated to the latest version.
```
git clone https://github.com/inventree/inventree/
```
Alternatively, the source can be downloaded as a [.zip archive](https://github.com/inventree/InvenTree/archive/master.zip).
Once the source is downloaded, cd into the source directory:
```
cd /path/to/inventree/
```
*(substitute /path/to/inventree/ with the directory where you have downloaded the source code)*.
## Installation
Now that the source code is downloaded (and optionally you have configured a Python virtual environment), the Python packages required to run InvenTree can be installed. InvenTree is a Python/Django application and relies on the pip package manager. All packages required to develop and test InvenTree are installed via pip. Package requirements can be found in ``requirements.txt``.