Development

Please feel free to contribute to this project. The following list describes just the basics to start development.

1. Clone the project

You can clone the current development version from github:

$ git clone https://github.com/jokiefer/django-mptt2

Dependencies in this project are organized by seperated requirement files under the .requirements folder.

To install all dependencies to contribute to this project run the command below:

$ pip install -r requirements.txt

Fullify playwright installation

$ playwright install

Note

Run the above command from the root of the project folder.

The javascript dependencies in this project are organized by the package.json and package-lock.json files.

To install all dependencies to contribute to this project run the command below:

$ npm install

Note

Run the above command from the root of the project folder.

After that npm will install the node_modules and move the sorable lib to the mptt2 static folder.

As other django based projects we test it with the default django test command.

$ python manage.py test

Note

Run the above command from the root of the project folder.

The documentation are build with sphinx.

To build the docs local change to the docs subfolder and run the command below.

$ make html

The documentation is present under the subfolder build/index.html