From 9289199b15b0e1c19cdfab958061ec66eefc0fe5 Mon Sep 17 00:00:00 2001 From: 42CrMo4 <44754810+42CrMo4@users.noreply.github.com> Date: Fri, 19 Mar 2021 09:58:28 +0100 Subject: [PATCH 1/5] Fix installation run server Typo --- docs/start/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/start/install.md b/docs/start/install.md index a1922c2..48e8b63 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -203,7 +203,7 @@ inv server For more server options, run: ``` -inv server -h +inv server -a ``` This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For other options refer to the [django docs](https://docs.djangoproject.com/en/2.2/ref/django-admin/) From 16f876ac2696c75a9a3501e416f8981a8b3d0c06 Mon Sep 17 00:00:00 2001 From: 42CrMo4 <44754810+42CrMo4@users.noreply.github.com> Date: Fri, 19 Mar 2021 10:04:09 +0100 Subject: [PATCH 2/5] Fix changed order in installation setup moved download sourve before python setup to be able to use the invoke command. --- docs/start/install.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/start/install.md b/docs/start/install.md index 48e8b63..ddbbae0 100644 --- a/docs/start/install.md +++ b/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. @@ -120,24 +138,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``. From 336a5663993e77d7e994865048e4c85ac7f7eea7 Mon Sep 17 00:00:00 2001 From: 42CrMo4 <44754810+42CrMo4@users.noreply.github.com> Date: Fri, 19 Mar 2021 10:16:02 +0100 Subject: [PATCH 3/5] Added Env activation option note On some systems the source command is not available. Use of "." should help --- docs/start/install.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/start/install.md b/docs/start/install.md index ddbbae0..3a46049 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -105,6 +105,8 @@ python3 -m venv inventree-env source inventree-env/bin/activate ``` +!!! 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: ``` From b4471759df392aa30d7e0fd1e8b8f25c3f729c10 Mon Sep 17 00:00:00 2001 From: 42CrMo4 <44754810+42CrMo4@users.noreply.github.com> Date: Fri, 19 Mar 2021 10:54:12 +0100 Subject: [PATCH 4/5] Fix Env activation option note Added the syntax for a readthedocs note --- docs/start/install.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/start/install.md b/docs/start/install.md index 3a46049..cd03650 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -105,7 +105,15 @@ python3 -m venv inventree-env source inventree-env/bin/activate ``` -!!! If "source inventree-env/bin/activate" is not working try ". 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: From 76a06884a3496e74267d2e679cf09ad3eaeee3fb Mon Sep 17 00:00:00 2001 From: 42CrMo4 <44754810+42CrMo4@users.noreply.github.com> Date: Fri, 19 Mar 2021 11:38:31 +0100 Subject: [PATCH 5/5] Revert "Fix installation run server Typo" This reverts commit 9289199b15b0e1c19cdfab958061ec66eefc0fe5. --- docs/start/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/start/install.md b/docs/start/install.md index cd03650..5305b06 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -213,7 +213,7 @@ inv server For more server options, run: ``` -inv server -a +inv server -h ``` This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For other options refer to the [django docs](https://docs.djangoproject.com/en/2.2/ref/django-admin/)