Practicalli Software Development

Software development guides and live coding screencasts, with a focus on the Clojure programming language.

██████╗ ██████╗  █████╗  ██████╗████████╗██╗ ██████╗ █████╗ ██╗     ██╗     ██╗
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║     ██║     ██║
██████╔╝██████╔╝███████║██║        ██║   ██║██║     ███████║██║     ██║     ██║
██╔═══╝ ██╔══██╗██╔══██║██║        ██║   ██║██║     ██╔══██║██║     ██║     ██║
██║     ██║  ██║██║  ██║╚██████╗   ██║   ██║╚██████╗██║  ██║███████╗███████╗██║
╚═╝     ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝   ╚═╝   ╚═╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝

Status

Creative commons license

This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License (including images & stylesheets).

Contributing

Please read the detailed Practicalli contributing page before raising an issue or pull request to avoid disappointment.

By submitting content ideas and corrections you agree they can be used in any work by Practicalli under the Creative Commons Attribution ShareAlike 4.0 International license.

Attribution is detailed via GitHub contributors.

Sponsor Practicalli

All sponsorship funds are used to support the continued development of Practicalli series of books and videos, although most work is done at personal cost and time.

Thanks to Nubank and a wide range of other GitHub sponsors for their continued support

GitHub Actions

The megalinter GitHub workflow runs when a pull request is created, checking markdown syntax and links.

A review of the change will be carried out by the Practicalli team and the PR merged if the change is acceptable.

The Docs workflow will run when PR's are merged into main (or the Practicalli team pushes changes to the default branch).

The Docs workflow installs UV and runs Zensical as a tool to build the site. GitHub actions are used to create a new pages deployment.

Local development

Zensical can be installed locally via vu or pip. Practicalli uses uv and installs Zensical as a tool for simplicity.

CLI Commands are wrapped in tasks defined within the Makefile, providing a simpler and consistent user experience.

Zensical - Practcialli Engineering Playbook

Clone the repository and change into the root of the project.

git clone https://github.com/practicalli/cycling

Install Zensical as a tool using uv (updating if there is a new version).

make docs-install

Or use the uv command:

uv tool install zensical --with catppuccin-zensical --upgrade

Build the website and serve locally at http://localhost:8000

make docs

Or use the zensical command:

zensical serve --dev-addr localhost:7777

---

Specific command if now using make:

Create a virtual python in the root of the project.

uv tool install zensical --upgrade