Skip to content

Conversation

Copy link

Copilot AI commented Jun 3, 2025

This PR adds a comprehensive SETUP.md document that provides detailed setup instructions for first-time users, addressing the need for better setup guidance identified in the issue.

What's Added

Complete Setup Documentation (357 lines)

  • Project Overview: Clear explanation of Sustineo's architecture (FastAPI backend + React frontend)
  • Prerequisites: System requirements and software dependencies
  • Multiple Setup Approaches:
    • VS Code Dev Containers (recommended)
    • Manual local setup
    • GitHub Codespaces
  • Step-by-step Instructions: Detailed commands for both API and web components
  • Environment Configuration: Complete documentation of required Azure service variables
  • Production Deployment: Azure Container Apps workflow explanation
  • GitHub Actions Documentation: Detailed explanation of CI/CD pipelines
  • Troubleshooting Guide: Common issues and solutions

Key Features

Development Environment Options

# Option 1: Dev Container (automatic)
code ."Reopen in Container"

# Option 2: Manual setup
cd api && python3 -m venv .venv && pip install -r requirements.txt
cd web && npm install && npm run dev

Complete Environment Variables Reference

All required Azure services documented with clear descriptions:

  • AZURE_VOICE_ENDPOINT - Azure OpenAI voice service
  • COSMOSDB_CONNECTION - Cosmos DB connection string
  • SUSTINEO_STORAGE - Azure Storage account URL
  • And 8 additional environment variables with usage notes

Deployment Workflow Documentation

Detailed explanation of the GitHub Actions workflows for:

  • API deployment (azure-container-api.yml)
  • Web deployment (azure-container-web.yml)
  • Required GitHub secrets and Azure resources

Comprehensive Troubleshooting

Common issues covered:

  • Port conflicts and service startup problems
  • Python virtual environment issues
  • Node.js dependency problems
  • Azure service connectivity
  • Dev container setup issues

Validation

  • ✅ Web build process tested successfully
  • ✅ Documentation structure follows project conventions
  • ✅ All referenced files and paths verified
  • ✅ Links to external documentation included

The documentation provides everything a first-time contributor needs to get the development environment running and understand the deployment process.

Fixes #52.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • http://168.63.129.16:80/machine/
    • Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@sethjuarez sethjuarez closed this Jun 3, 2025
Copilot AI changed the title [WIP] This project should have better setup instructions Add comprehensive SETUP.md documentation for development environment Jun 3, 2025
Copilot AI requested a review from sethjuarez June 3, 2025 19:24
Copilot finished work on behalf of sethjuarez June 3, 2025 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

This project should have better setup instructions

2 participants