Files
tacticalrmm/docs/docs/contributing_using_devbox.md
2021-04-06 04:12:56 +00:00

1.5 KiB

Hidden docs, needs work

For local Hyper-v Devbox notes

From https://raw.githubusercontent.com/silversword411/tacticalrmm-devdocs

Needs an official install_devbox.sh script

Setup local devbox in hyper-v VM

Install Ubuntu 20.04 LTS

Don't forget to

sudo apt-get updates && sudo apt-get upgrade

Optional

Set all users in sudo group not to require password every time:

sudo visudo

Add this:

%sudo ALL=(ALL) NOPASSWD: ALL

Download customized install script and tweak

Create folder to dump into

sudo mkdir /rmm
sudo chown ${USER}:${USER} -R /rmm
cd /rmm

Get dev install script

wget https://raw.githubusercontent.com/silversword411/tacticalrmm-devdocs/blob/main/install_devbox.sh

Edit, and search for REPLACEMEWITHYOURFORKEDREPOURL

and replace with your forked repo URL (example commented out below)

Run it

./install_devbox.sh

Watch for

Image

!!!Note Unlike regular installs, don't worry about the QR code

Celebrate

Image

Misc commands

Start mkdocs on dev box

cd /rmm/api
source env/bin/activate
pip install --upgrade pip
pip install --upgrade setuptools wheel
pip install -r tacticalrmm/requirements-dev.txt
cd /rmm/docs
mkdocs serve

Running tests locally

Prep and update

source /rmm/api/env/bin/activate
cd /rmm/api/tacticalrmm
pip install -r requirements.txt

Then run tests

python manage.py test