|
| 1 | +# SecuLite v2 - Platform Development Plan |
| 2 | + |
| 3 | +This directory contains all detailed planning documents for the development of SecuLite v2, a comprehensive, self-hosted security monitoring platform. |
| 4 | + |
| 5 | +Our goal is to achieve a "mental finish" of the project plan – detailing architecture, database design, API structure, task breakdowns, UI/UX concepts, and Docker setup – before major coding commences. |
| 6 | + |
| 7 | +## Planning Documents: |
| 8 | + |
| 9 | +1. **[01_architectural_decisions.md](01_architectural_decisions.md)** |
| 10 | + * Records key architectural choices for the platform (backend framework, database, task queue, frontend approach, etc.). |
| 11 | + * May link to more detailed Architectural Decision Records (ADRs) in a sub-directory. |
| 12 | + |
| 13 | +2. **[02_database_schema.md](02_database_schema.md)** |
| 14 | + * Outlines the database models, entities, relationships (ERD concepts), and data types. |
| 15 | + |
| 16 | +3. **[03_api_design.md](03_api_design.md)** |
| 17 | + * Describes the high-level design for the backend API, including key resource endpoints, request/response structures, and authentication mechanisms. |
| 18 | + |
| 19 | +4. **[04_task_breakdown_phase1.md](04_task_breakdown_phase1.md)** |
| 20 | + * A detailed, actionable list of tasks for implementing "SecuLite v2 - Phase 1: Foundational Refactoring & Core Platform Development." |
| 21 | + * May be further broken down into more granular task files. |
| 22 | + |
| 23 | +5. **[05_ui_ux_concepts_v1.md](05_ui_ux_concepts_v1.md)** |
| 24 | + * Initial ideas, user stories, wireframes, or mockups for the new web dashboard and user interface. |
| 25 | + |
| 26 | +6. **[06_docker_setup_v2.md](06_docker_setup_v2.md)** |
| 27 | + * Planning for the updated `Dockerfile` and `docker-compose.yml` required to support the new multi-service architecture (backend, database, task workers, frontend (if separate), reverse proxy, etc.). |
| 28 | + |
| 29 | +7. **[ADRs/](ADRs/)** (Architectural Decision Records) - *Optional Sub-directory* |
| 30 | + * If we choose to use ADRs, this directory will store them. |
| 31 | + |
| 32 | +## Related Top-Level Plans: |
| 33 | + |
| 34 | +* **[../PLAN.md](../PLAN.md):** High-level project roadmap for SecuLite v2 phases. |
| 35 | +* **[../detailed_plan.md](../detailed_plan.md):** Overall project vision, objectives, and evolved conceptual architecture. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +*This plan is a living document and will be updated as decisions are made and details are fleshed out.* |
0 commit comments