mirror of
https://github.com/SamyRai/turash.git
synced 2025-12-26 23:01:33 +00:00
000eab4740
Repository Structure:
- Move files from cluttered root directory into organized structure
- Create archive/ for archived data and scraper results
- Create bugulma/ for the complete application (frontend + backend)
- Create data/ for sample datasets and reference materials
- Create docs/ for comprehensive documentation structure
- Create scripts/ for utility scripts and API tools
Backend Implementation:
- Implement 3 missing backend endpoints identified in gap analysis:
* GET /api/v1/organizations/{id}/matching/direct - Direct symbiosis matches
* GET /api/v1/users/me/organizations - User organizations
* POST /api/v1/proposals/{id}/status - Update proposal status
- Add complete proposal domain model, repository, and service layers
- Create database migration for proposals table
- Fix CLI server command registration issue
API Documentation:
- Add comprehensive proposals.md API documentation
- Update README.md with Users and Proposals API sections
- Document all request/response formats, error codes, and business rules
Code Quality:
- Follow existing Go backend architecture patterns
- Add proper error handling and validation
- Match frontend expected response schemas
- Maintain clean separation of concerns (handler -> service -> repository)
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# Application Documentation
|
|
|
|
This directory contains core application documentation essential for understanding and working with the Turash platform.
|
|
|
|
## Core Documents
|
|
|
|
### [MVP Concept](mvp_concept.md)
|
|
Complete specification of the Minimum Viable Product including:
|
|
- Business logic and user workflows
|
|
- Technical architecture decisions
|
|
- Feature prioritization and scope
|
|
- Implementation roadmap
|
|
|
|
### [Database Structure](database_structure.md)
|
|
Complete database schema and relationships:
|
|
- Entity definitions and relationships
|
|
- Table structures and constraints
|
|
- Indexing strategy
|
|
- Migration patterns
|
|
|
|
## Usage
|
|
|
|
**For New Developers**: Start with [MVP Concept](mvp_concept.md) to understand what the application does and how it works.
|
|
|
|
**For Database Work**: Read [Database Structure](database_structure.md) to understand the data model and relationships.
|
|
|
|
**For Architecture Decisions**: Both documents provide the foundation for understanding technical choices and constraints.
|
|
|
|
## Relationship to Other Documentation
|
|
|
|
- **[Concept Docs](../concept/)**: Strategic vision and market analysis
|
|
- **[Implementation Docs](../implementation/)**: Technical implementation plans and status
|
|
- **[Business Docs](../business/)**: Business strategy, funding, and branding
|
|
- **[Dev Guides](../dev_guides/)**: Framework and tool documentation
|