netplan.io

This is the repo for the Netplan site

Local development

Using Task (Recommended)

The recommended way to run the site locally uses Task for dependency management and task automation.

Prerequisites:

• Task installed

Setup and run:

# install Task
sudo snap install task --classic

# Start the development server with watch mode
task start

This will build the CSS/JS and start the Flask server at http://127.0.0.1:8024. Changes to Sass/JS files will automatically rebuild.

Useful tasks:

• task build - Build CSS and JavaScript assets
• task watch - Watch for file changes and rebuild assets (run in separate terminal)
• task serve - Run the Flask server only
• task test - Run all tests
• task lint - Run linters (Python, JS, SCSS)
• task format - Format Python code
• task clean - Remove build artifacts and dependencies
• task clean-all - Complete environment reset

Using Docker (Alternative)

Prerequisites:

• dotrun installed

# at project root
dotrun

Once the containers are setup, you can visit http://127.0.0.1:8024 in your browser.

Deploy

You can find the deployment config in the deploy folder.