Merge pull request #55 from castiel10k/master

Added Windows release and installation instructions in it's own markdown file.

doc/WINDOWS_INSTALLATION.md

@@ -0,0 +1,187 @@
+# Windows 10 version 2004 and up or 11 - release and development
+
+A guide on how to set up a workspace and run ERPLibre on Windows 10 version 2004 and up or Windows 11. There are two methods of installation, one is automatic and the other manual.
+
+**"WSL2 Ubuntu 22.04" will be referred as "WSL2"**
+
+**"PyCharm Professional" will be referred as "PyCharm"**
+
+## Install WSL2
+
+Run Powershell with administrator rights and run the following command:
+```bash
+wsl --install -d Ubuntu-22.04
+```
+
+If you have trouble opening the Powershell with administrator rights, press `Windows + R`, enter the following line and press `OK`. You will be  automatically prompted for administrator rights.
+```bash
+powershell.exe
+```
+
+### Troubleshooting - Optional
+If you have issues enable virtualization options in BIOS is available (hyper-v, vt-x, etc). Search for `Turn Windows features on or off` in the Windows search bar and ensure that `Windows Subsystem for Linux` is turned on before restarting your machine. 
+
+You can also try theses powershell commands:
+```bash
+dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
+wsl --set-default-version 2
+```
+
+Download and install the lastest Linux kernel update package from Microsoft with the following [link](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi):
+```bash
+https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi
+```
+
+Only run this command as your last resort as it can break other virtual machines:
+```bash
+bcdedit /set hypervisorlaunchtype auto
+```
+
+### Other Installation methods for WSL2
+
+Run Powershell with administrator rights and run the following command:
+```bash
+curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
+```
+
+Run Powershell with administrator rights and run the following commands:
+```bash
+Invoke-WebRequest -Uri https://aka.ms/wslubuntu2004 -OutFile Ubuntu.appx -UseBasicParsing
+Add-AppxPackage .\Ubuntu.appx 
+```
+
+Install WSL2 from the Microsoft Store with the following [link](https://apps.microsoft.com/store/detail/ubuntu-22041-lts/9PN20MSR04DW):
+```bash
+https://apps.microsoft.com/store/detail/ubuntu-22041-lts/9PN20MSR04DW
+```
+
+## Setup WSL2 for ERPLibre
+
+Once WSL2 has been installed correctly, reboot your computer. Once back into Windows, run the following commands in WSL2:
+
+### Installation of the necessary and up-to-date tools
+
+```bash
+sudo apt update
+sudo apt install build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libsqlite3-dev libreadline-dev libffi-dev curl libbz2-dev rsync make git
+```
+
+## Installation of ERPLibre under WSL2
+
+Make sure to be in the directory where you want to clone the project.
+```bash
+git clone https://github.com/ERPLibre/ERPLibre.git
+cd ERPLibre
+make install
+```
+
+Add role to PostgresSQL, change `USERNAME` field in the command with your UNIX username from your WSL2 environment.
+```bash
+sudo service postgresql start
+sudo su - postgres -c "createuser -s USERNAME" 2>/dev/null || true
+```
+
+## Running ERPLibre
+
+Everytime you restart your machine, the following command has to be executed to start the PostgreSQL service if it is not already running:
+```bash
+sudo service postgresql start
+```
+
+After that run this command in the root of the project:
+```bash
+./run.sh
+```
+
+## Set up Development Environment - PyCharm
+
+### Install PyCharm
+
+Install PyCharm from the following [link](https://www.jetbrains.com/pycharm/download/#section=windows):
+```bash
+https://www.jetbrains.com/pycharm/download/#section=windows
+```
+
+### Set up Pycharm 
+
+Select `Connect to WSL` under `Remote Development`. After that select your Ubuntu instace ("Ubuntu-22.04"). Point `Project directory` to the root of the project. Once everything has been selected and filled out correctly, click on `Start IDE and Connect`.
+
+![Welcome to PyCharm Wizard](image/remote_development.png)
+
+Press `CTRL+ALT+S`, search for `interpreter` and inside the `Python Interpreter` page, click on `Add Interpreter` and select `Add Local Interpreter...`.
+
+![Interpreter Settings](image/add_local_interpreter.png)
+
+Make sure to select `Virtualenv Environment` on the left and the `Existing` radio button. Once theses are both selected properly, point your interpreter to the `../ERPLibre/.venv/bin/python` directory of the project and click on `OK`.
+
+![Environment Settings](image/existing_venv.png)
+
+If these last steps to set up your development environment were unsuccessful, follow the next "Manual" steps to set up your environment. 
+
+## Manual Installation
+
+### Install Python 3.7.16
+You can delete the files that are left over in your home directory regarding the python installation when the steps have been completed succesfully. 
+```bash
+cd ~
+wget https://www.python.org/ftp/python/3.7.16/Python-3.7.16.tgz
+tar -xzf Python-3.7.16.tgz
+cd Python-3.7.16
+./configure --enable-optimizations
+make -j $(nproc)
+sudo make install
+```
+
+### Verify the installation
+
+```bash
+python3.7
+```
+
+### Set Python 3.7.16 as default
+
+```bash
+alias python='/usr/local/bin/python3.7'
+source ~/.bashrc
+```
+
+### Set up Pycharm 
+
+Open the project directory in PyCharm.
+
+Press `CTRL+ALT+S`, search for `interpreter` and inside the `Python Interpreter` page, click on `Add Interpreter` and select `On WSL...`.
+
+![Interpreter Settings](image/on_wsl.png)
+
+Wait until PyCharm detects your WSL2 instance and press `NEXT`. Click on `System Interpreter` on the left, select the correct interpreter if it hasn't done so automatically and click `Create`.
+
+![System Interpreter](/image/system_python.png)
+
+Close the project's settings. Once PyCharm prompts you to import modules and allow it.
+
+## Common problems with Windows Development
+
+### Broken Terminal
+
+Search for `terminal` in the settings, and under `Application Settings` in the `Shell path:` field enter the following line:
+
+```bash
+wsl.exe
+```
+![Shell Path - Terminal](image/shell_path.png)
+
+### High Memory Usage warnings
+
+Click on `Help` in the toolbar and choose `Change Memory Settings` to increase the memory heap of the IDE.
+
+### Missing or incorrect imported modules
+PyCharm may ignore some information from the `requirements.txt` and `pyproject.toml` from the project (such as their specific versions). If you have problems at runtime or while debugging with a certain module, search for the correct version of that specific module and reinstall it from PyCharm's package manager.
+
+### Can't run ERPLibre from PyCharm
+Run the following command in the root of the project from the terminal in PyCharm or WSL2
+```bash
+./script/ide/pycharm_configuration.py
+```
+
+### Can't restart ERPLibre
+Run `htop` from the terminal in PyCharm or WSL2 and close the python processes related to ERPLibre to release the socket.