v0.1.1

This release focuses on significant documentation enhancements and continues the theme of styling optimizations with the update to Tailwind CSS v4.

✨ New Features & Enhancements

• Tailwind CSS v4 Upgrade: Updated the frontend to utilize Tailwind CSS v4, bringing the latest styling capabilities and optimizations to the frontend.
• Styling Optimizations: Implemented various styling improvements and optimizations across the frontend for a cleaner and more efficient user interface.

📚 Documentation

This release introduces a comprehensive documentation suite built with MkDocs and the Material for MkDocs theme, fully integrated into the Docker Compose environment and deployable to GitHub Pages.

• Complete Project Documentation:
  • index.md: Project overview, key features, and quick navigation.
  • initial_setup.md: Detailed instructions for prerequisites, environment configuration, and multiple setup methods (Docker, automated scripts, manual).
  • development.md: Comprehensive guide covering project structure, backend (FastAPI) and frontend (React) development practices, linting, formatting, testing placeholders, Docker usage, pre-commit hooks, and debugging tips.
  • deployment.md: Instructions for production deployment using Docker Compose, environment variable configuration, production-specific compose adjustments, reverse proxy considerations, and deploying the documentation site itself.
  • make_it_yours.md: A guide for users to adapt the starter template for their own projects, including renaming, backend/frontend customization, and Docker configuration.
  • roadmap.md: A template for outlining project goals, now including initial items like Backend/Frontend Testing, Admin Panel, and Maintenance Processes.
• MkDocs Configuration:
  • Set up mkdocs.yml for site navigation, theme, and plugins.
  • Configured docs/requirements.txt for documentation dependencies.
  • Adjusted MkDocs configuration to support gh-deploy by moving mkdocs.yml to the project root.
• Docker Integration:
  • Added a Dockerfile in the docs/ directory for the MkDocs service.
  • Integrated the docs service into the main docker-compose.yml, exposing it on port 8001.
  • Updated Docker configurations to reflect mkdocs.yml in the project root.
• Deployment Automation:
  • Created a GitHub Actions workflow (.github/workflows/docs-deploy.yml) to automatically build and deploy the documentation to GitHub Pages on pushes to the main branch (for docs/ or mkdocs.yml changes) or via manual trigger.
  • Configured site_url in mkdocs.yml for correct GitHub Pages deployment.
• Build Hygiene:
  • Added a .dockerignore file to the project root to exclude virtual environments, node_modules, and other unnecessary files from Docker build contexts, cleaning up documentation builds.
  • Added the MkDocs site/ build output directory to .gitignore.
• Pre-commit Hooks:
  • Updated .pre-commit-config.yaml to exclude the docs/ directory and Markdown files from prettier, trailing-whitespace, and end-of-file-fixer hooks.