mukimovd/turash
1
0
Fork 0
mirror of https://github.com/SamyRai/turash.git synced 2025-12-26 23:01:33 +00:00
Code Issues 1 Actions Packages Projects Releases Wiki Activity
0dac4072fc
turash/docs/dev_guides/README.md
Damir Mukimov 000eab4740
Major repository reorganization and missing backend endpoints implementation 
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)
2025-11-25 06:01:16 +01:00

2.2 KiB
Raw Blame History

Development Guides Index

Quick reference guides for libraries and concepts used in the Turash MVP.

HTTP Frameworks

04_echo_framework.md ⭐ Primary Choice

  • Library: github.com/labstack/echo/v4
  • Used For: Primary HTTP API server
  • Key Topics: Routing, middleware, validation, error handling

01_gin_framework.md - Alternative

  • Library: github.com/gin-gonic/gin
  • Used For: Alternative HTTP framework (if needed)
  • Key Topics: Routing, middleware, request binding, error handling

Databases

02_neo4j_driver.md

  • Library: github.com/neo4j/neo4j-go-driver/v5
  • Used For: Graph database for resource matching
  • Key Topics: Driver setup, Cypher queries, transactions, graph patterns

03_gorm.md ⭐ Primary Choice

  • Library: gorm.io/gorm
  • Used For: PostgreSQL ORM with PostGIS support
  • Key Topics: Models, migrations, CRUD, relationships, PostGIS integration

05_pgx_postgres.md - Alternative

  • Library: github.com/jackc/pgx/v5
  • Used For: PostgreSQL driver (if raw SQL needed)
  • Key Topics: Connection pooling, PostGIS spatial queries, transactions

Caching & Concurrency

06_go_channels_goroutines.md

  • Library: Built-in Go concurrency
  • Used For: Event processing, background workers, worker pools
  • Key Topics: Goroutines, channels, worker pools, graceful shutdown

07_redis_go.md

  • Library: github.com/redis/go-redis/v9
  • Used For: Caching match results, sessions, rate limiting
  • Key Topics: Caching patterns, session management, rate limiting

Coming Soon

  • WebSockets - Real-time updates (gorilla/nhooyr)
  • Validator - Input validation (go-playground/validator)
  • Testing - Go testing patterns and best practices

Quick Links