Admin/panel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
84f63c37cecb5ab5fc56223a3834fe7ed0495fc3
panel/docs/README.md
RKWojs d4f16d344d feat: Implement comprehensive Contacts Management System with API and UI integration 
- Added new `contacts` and `project_contacts` database tables for managing contacts.
- Created API endpoints for CRUD operations on contacts and linking them to projects.
- Developed UI components including `ContactForm` and `ProjectContactSelector`.
- Integrated navigation and translations for Polish language support.
- Documented usage, features, and future enhancements for the contacts system.

feat: Introduce DOCX Template System for generating documents from templates

- Enabled creation and management of DOCX templates with placeholders for project data.
- Documented the process for creating templates, uploading, and generating documents.
- Included detailed information on available variables and custom data fields.
- Implemented troubleshooting guidelines for common issues related to template generation.

feat: Add Radicale CardDAV Sync Integration for automatic contact synchronization

- Implemented automatic syncing of contacts to a Radicale server on create/update/delete actions.
- Documented setup instructions, including environment variable configuration and initial sync script.
- Provided troubleshooting steps for common sync issues and error codes.

feat: Develop Route Planning Feature with Optimization using OpenRouteService API

- Integrated multi-point routing and automatic optimization for project locations.
- Documented setup, usage, and technical implementation details for route planning.
- Included performance considerations and troubleshooting for common routing issues.

chore: Remove unnecessary files and scripts from the codebase

- Deleted temporary, debug-related, and test-specific files that are not needed in production.
- Reviewed and ensured core application code and essential documentation remain intact.
2026-01-16 11:11:29 +01:00

2.9 KiB
Raw Blame History

Documentation Index

eProjektant Wastpol - Complete documentation directory

📚 Main Documentation

  • Main README - Project overview, installation, API reference, deployment
  • Roadmap - Development roadmap, feature priorities, timelines

🎯 Feature Documentation

Core Features

  • Contacts System - Contact management, CardDAV sync, project linking
  • DOCX Templates - Document generation, available variables, examples
  • Radicale Sync - CardDAV integration, automatic sync, troubleshooting
  • Route Planning - Route optimization, multi-point routing, ORS integration

Map System

  • Map Layers - WMTS/WMS configuration, adding custom layers, Polish geoportal

🚀 Deployment Documentation

📖 Quick Links by Topic

Getting Started

  1. Installation Guide
  2. Environment Configuration
  3. Creating Admin User
  4. Docker Setup

Development

  1. Project Structure
  2. Available Scripts
  3. Database Schema
  4. Testing

Features

  1. Authentication & Roles
  2. Project Management
  3. Task System
  4. Notifications
  5. GIS/Mapping
  6. Document Generation
  7. Contact Management

API

  1. API Endpoints
  2. Authentication Endpoints
  3. Projects API
  4. Contacts API

Deployment

  1. Production Deployment
  2. Docker Deployment
  3. Git-Based Deployment
  4. Environment Variables

🔧 Troubleshooting

📝 Contributing

See ROADMAP.md for development priorities and README - Contributing for guidelines.

Last Updated: January 16, 2026
Version: 0.1.1