Setup¶

This page will define the step-by-step to build this project.

This project assumes you have the latest version of Python, PIP and GIT,

This project was developed using python version Python 3.10.x

Clone the repo¶

Bash

git clone https://github.com/HefestusTec/bolinho

cd bolinho

The following step isn't mandatory but recommended.

Bash

python -m pip install --user virtualenv

python -m venv venv

The a directory venv should be created in the root folder.

How to activate:

Windows activation

venv/Scripts/activate

or

Linux activation

source venv/bin/activate

Bash

npm run installDep

The following step is only required for those that want to edit the documentation.

Bash

pip install -r docs/requirements.txt

We have two options to create a build:

Serve:

This option is used for debugging, it will open the static page in one of the localhost ports.
```
mkdocs serve
```
Build:

This option creates a build of the documentation and saves it on de directory /site/.
```
mkdocs build
```

Note

Be aware of the Environment Variable ENABLE_PDF_EXPORT, it will only generate the PDF if this variable is set to 1.

You can change the mkdocs.yml file and remove this line if you so choose.

For more info about the documentation please checkout ZRafaF/ReadTheDocksBase.