aclarknet Documentation

Welcome to the aclarknet documentation! This is a Django-based web application using Wagtail CMS with a modern frontend stack.

This documentation follows the Diátaxis framework, organizing content into four types:

  • Tutorials - Learning-oriented lessons for beginners

  • How-to Guides - Goal-oriented directions for specific tasks

  • Reference - Information-oriented technical descriptions

  • Explanation - Understanding-oriented context and background

Tutorials:

How-to Guides:

Reference:

Explanation:

Quick References:

Getting Started

New to aclarknet? Start with Getting Started with aclarknet to set up your development environment and create your first client.

Need to accomplish a specific task? Check out the How-to Guides for goal-oriented guides.

Looking for technical details? See the Reference for complete API documentation.

Want to understand how it works? Read the Explanation for context and background.

Project Overview

This is a Django-based web application using Wagtail CMS with a modern frontend stack. The project combines Django’s robust backend capabilities with Wagtail’s powerful content management features, along with a React-based frontend built with Webpack.

Tech Stack

Backend

  • Django 6.0: Main web framework

  • Wagtail: CMS framework for content management

  • MongoDB: Database backend using django-mongodb-backend

  • Django Allauth: Authentication and social account management

  • Django reCAPTCHA: Google reCAPTCHA v3 integration for form protection

  • Django SES: AWS Simple Email Service integration

  • Python 3.13: Target Python version

Frontend

  • React 19: UI library

  • Webpack 5: Module bundler

  • Tailwind CSS 4: Utility-first CSS framework

  • Bootstrap 5: CSS framework

  • Babel: JavaScript transpiler

  • SASS: CSS preprocessor

Development Tools

  • Ruff: Python linter and formatter

  • ESLint: JavaScript linter

  • Stylelint: CSS linter

  • pytest: Testing framework

  • pre-commit: Git hooks for code quality

  • just: Command runner

Key Features

  • Client Management: Categorize and feature clients on the public website

  • Notes & Testimonials: Manage contact form submissions and client testimonials

  • Contact Form: reCAPTCHA-protected contact form with email notifications

  • Email Integration: AWS SES integration with IAM role support

  • Wagtail CMS: Powerful content management system

  • Modern Frontend: React-based UI with Tailwind CSS

Important

Gmail showing warnings for your emails? See Gmail Warning Fix - Quick Summary for a quick fix, or Fix Gmail Warning for detailed instructions.

Indices and Tables