The Unfold repository contains a testing server that you can use to test any changes you make to the code. To start the server, navigate to tests/server and run uv run -- python manage.py runserver. This will start the server at http://localhost:8000.
Before running the server, you don't need to install anything, as uv will automatically take care of the dependencies.
Once the server is running, you need to create a superuser account to access the admin interface. To create a superuser, run uv run -- python manage.py createsuperuser.
To run the tests, navigate to the root of the repository and run the command below. The tests will run in the tests directory. Again, it is not necessary to install anything, as uv will automatically take care of the dependencies.
uv run -- pytest .
Unfold uses Tailwind CSS for styling and utility-first CSS classes. To work on or change styles, you'll need to compile Tailwind whenever you make updates to src/unfold/styles.css or related class usage.
To compile Tailwind CSS, you must have the standalone tailwindcss CLI installed.
On macOS (using Homebrew):
brew install tailwindcss
On other platforms:
You can download a prebuilt binary from the Tailwind CSS release page or follow instructions for your OS.
After installing tailwindcss, compile your CSS with the following command (run from your project root):
tailwindcss -i src/unfold/styles.css -o src/unfold/static/unfold/css/styles.css --minify --watch
Some components like datepickers, calendars or selectors in the admin interface cannot be styled by overriding HTML templates, so their default styles are overridden in styles.css.
Note: Most of the custom styles in styles.css are created via @apply some-tailwind-class; as it is not possible to manually add CSS classes to elements that are created via jQuery.
Before adding any source code, it is recommended to have pre-commit installed on your local computer to check for potential issues when committing code.
pip install pre-commit
pre-commit install
pre-commit install --hook-type commit-msg
pre-commit run --all-files # Check if everything is okay
© 2023 - 2026 Created by unfoldadmin.com. All rights reserved.