Skip to content

Project setup 🏗️

Before you start programming, you must setup the project locally.

First, you will need to fork the Github repository, and clone it.

bash
# Replace SkwalExe with your github username
git clone https://github.com/SkwalExe/fractalistic
cd fractalistic

PDM is used as a package manager for the project.
If you need to install it, you can do so as follows on Linux systems:

bash
curl -sSL https://pdm-project.org/install-pdm.py | python3 -

Then, install the project and the dependencies.

bash
pdm install

You can now start to make changes!

Running the app

Since Fractalistic uses a TUI (GUI-like interface but in the terminal) you cannot use print() statements.

You will need to open 2 separate terminals. In the first one run pdm console, and in the second one, run pdm run dev.

This will open the app in dev mode, allowing you to log messages to the Textual console (first terminal). To log messages within the code, you must use the textual.log() function, and import it if needed. (from textual import log)

Dev mode preview

Released under the GNU General Public License (GPLv3).