cardosofelipe/syndarix
1
0
Fork 0
forked from cardosofelipe/fast-next-template
Code Issues 18 Pull Requests Wiki Activity

Create development environment setup documentation #16

New Issue
Closed
opened 2025-12-29 23:45:59 +00:00 by cardosofelipe · 0 comments
cardosofelipe commented 2025-12-29 23:45:59 +00:00
Owner
Copy Link

Description

Write comprehensive documentation for setting up the Syndarix development environment.

Requirements

Documentation Contents

  1. Prerequisites (Python 3.12+, Node 20+, Docker, uv)
  2. Repository cloning and setup
  3. Environment variables configuration
  4. Database setup (PostgreSQL with pgvector)
  5. Redis setup
  6. Running the backend (uv run uvicorn)
  7. Running the frontend (npm run dev)
  8. Running with Docker Compose
  9. Running tests
  10. Common troubleshooting

File Structure

  • docs/DEVELOPMENT.md - Main setup guide
  • docs/TROUBLESHOOTING.md - Common issues and solutions

Acceptance Criteria

  • Fresh developer can set up environment following docs only
  • All commands tested and working
  • Environment variable templates provided
  • Troubleshooting section covers common issues

Technical Notes

  • Reference existing README.md but expand significantly
  • Include both local and Docker-based setup options

Assignable To

devops-engineer agent

## Description Write comprehensive documentation for setting up the Syndarix development environment. ## Requirements ### Documentation Contents 1. Prerequisites (Python 3.12+, Node 20+, Docker, uv) 2. Repository cloning and setup 3. Environment variables configuration 4. Database setup (PostgreSQL with pgvector) 5. Redis setup 6. Running the backend (`uv run uvicorn`) 7. Running the frontend (`npm run dev`) 8. Running with Docker Compose 9. Running tests 10. Common troubleshooting ### File Structure - `docs/DEVELOPMENT.md` - Main setup guide - `docs/TROUBLESHOOTING.md` - Common issues and solutions ## Acceptance Criteria - [ ] Fresh developer can set up environment following docs only - [ ] All commands tested and working - [ ] Environment variable templates provided - [ ] Troubleshooting section covers common issues ## Technical Notes - Reference existing README.md but expand significantly - Include both local and Docker-based setup options ## Assignable To devops-engineer agent
cardosofelipe added the devopsphase-0 labels 2025-12-29 23:49:39 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
agents
Agent orchestration
 architecture
Architectural decisions
 backend
Backend work
 blocked
Blocked by dependency
 database
Database/migrations
 design
UI/UX design work
 devops
DevOps/Infrastructure work
 epic
Epic/parent issue
 frontend
Frontend work
 infrastructure
Infrastructure / DevOps
 mcp
MCP related
 phase-0
Phase 0: Foundation
 phase-1
Phase 1: Core Platform
 phase-2
Phase 2: MCP Integration
 priority:high
High priority
 spike
Architecture spike / research task
No Label devops phase-0
Milestone
No items
No Milestone
Assignees
Clear assignees
cardosofelipe
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: cardosofelipe/syndarix#16
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?