RKWojs
d4f16d344d
- 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.
88 lines
2.9 KiB
Markdown
88 lines
2.9 KiB
Markdown
# Documentation Index
|
|
|
|
**eProjektant Wastpol** - Complete documentation directory
|
|
|
|
---
|
|
|
|
## 📚 Main Documentation
|
|
|
|
- **[Main README](../README.md)** - Project overview, installation, API reference, deployment
|
|
- **[Roadmap](../ROADMAP.md)** - Development roadmap, feature priorities, timelines
|
|
|
|
---
|
|
|
|
## 🎯 Feature Documentation
|
|
|
|
### Core Features
|
|
- **[Contacts System](features/CONTACTS_SYSTEM.md)** - Contact management, CardDAV sync, project linking
|
|
- **[DOCX Templates](features/DOCX_TEMPLATES.md)** - Document generation, available variables, examples
|
|
- **[Radicale Sync](features/RADICALE_SYNC.md)** - CardDAV integration, automatic sync, troubleshooting
|
|
- **[Route Planning](features/ROUTE_PLANNING.md)** - Route optimization, multi-point routing, ORS integration
|
|
|
|
### Map System
|
|
- **[Map Layers](MAP_LAYERS.md)** - WMTS/WMS configuration, adding custom layers, Polish geoportal
|
|
|
|
---
|
|
|
|
## 🚀 Deployment Documentation
|
|
|
|
- **[Advanced Deployment](deployment/ADVANCED_DEPLOYMENT.md)** - Detailed deployment strategies
|
|
- **[Git-Based Deployment](deployment/GIT_DEPLOYMENT.md)** - Git repository deployment, CI/CD
|
|
|
|
---
|
|
|
|
## 📖 Quick Links by Topic
|
|
|
|
### Getting Started
|
|
1. [Installation Guide](../README.md#-getting-started)
|
|
2. [Environment Configuration](../README.md#configuration)
|
|
3. [Creating Admin User](../README.md#getting-started)
|
|
4. [Docker Setup](../README.md#-docker-commands)
|
|
|
|
### Development
|
|
1. [Project Structure](../README.md#-project-structure)
|
|
2. [Available Scripts](../README.md#-available-scripts)
|
|
3. [Database Schema](../README.md#%EF%B8%8F-database-schema)
|
|
4. [Testing](../README.md#-testing)
|
|
|
|
### Features
|
|
1. [Authentication & Roles](../README.md#-security--authentication)
|
|
2. [Project Management](../README.md#-project-management)
|
|
3. [Task System](../README.md#-advanced-task-system)
|
|
4. [Notifications](../README.md#-notification-system)
|
|
5. [GIS/Mapping](MAP_LAYERS.md)
|
|
6. [Document Generation](features/DOCX_TEMPLATES.md)
|
|
7. [Contact Management](features/CONTACTS_SYSTEM.md)
|
|
|
|
### API
|
|
1. [API Endpoints](../README.md#-api-endpoints)
|
|
2. [Authentication Endpoints](../README.md#authentication)
|
|
3. [Projects API](../README.md#projects)
|
|
4. [Contacts API](../README.md#contacts)
|
|
|
|
### Deployment
|
|
1. [Production Deployment](../README.md#-deployment)
|
|
2. [Docker Deployment](deployment/ADVANCED_DEPLOYMENT.md)
|
|
3. [Git-Based Deployment](deployment/GIT_DEPLOYMENT.md)
|
|
4. [Environment Variables](../README.md#environment-variables)
|
|
|
|
---
|
|
|
|
## 🔧 Troubleshooting
|
|
|
|
- **Database Issues**: See [README - Troubleshooting](../README.md#-troubleshooting)
|
|
- **Map Layers**: See [Map Layers Guide](MAP_LAYERS.md)
|
|
- **CardDAV Sync**: See [Radicale Sync](features/RADICALE_SYNC.md)
|
|
- **Route Planning**: See [Route Planning Guide](features/ROUTE_PLANNING.md)
|
|
|
|
---
|
|
|
|
## 📝 Contributing
|
|
|
|
See [ROADMAP.md](../ROADMAP.md) for development priorities and [README - Contributing](../README.md#-contributing) for guidelines.
|
|
|
|
---
|
|
|
|
**Last Updated**: January 16, 2026
|
|
**Version**: 0.1.1
|