{"id":18578269,"url":"https://github.com/codecsrayo/homeprice","last_synced_at":"2025-05-16T01:36:13.856Z","repository":{"id":256499073,"uuid":"854331449","full_name":"codecsrayo/HomePrice","owner":"codecsrayo","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-08T22:23:19.000Z","size":2839,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-16T01:35:50.263Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codecsrayo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-09T01:11:51.000Z","updated_at":"2025-03-08T22:23:22.000Z","dependencies_parsed_at":"2024-11-06T23:38:28.183Z","dependency_job_id":"ec4e4b85-7e78-49bb-a5a8-8b6ec340f4fd","html_url":"https://github.com/codecsrayo/HomePrice","commit_stats":null,"previous_names":["codecsrayo/homepricebackend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecsrayo%2FHomePrice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecsrayo%2FHomePrice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecsrayo%2FHomePrice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecsrayo%2FHomePrice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codecsrayo","download_url":"https://codeload.github.com/codecsrayo/HomePrice/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254453608,"owners_count":22073609,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T23:34:25.886Z","updated_at":"2025-05-16T01:36:13.843Z","avatar_url":"https://github.com/codecsrayo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# House Price Analysis Project\n\nThis project consists of a backend API built with FastAPI, a frontend built with Astro, and uses PostgreSQL for the database. The application uses Docker and Docker Compose for both development and production environments.\n\n## Prerequisites\n\n- Docker and Docker Compose\n- Make\n\n## Quick Start\n\n```bash\n# Install make if not installed\nsudo apt install make\n\n# Copy environment file\nmv .devcontainer/.env.example .devcontainer/.env\n\n# Start the application\nmake up\n```\n\n## Deployment\n\nThe project supports two deployment environments: development and production.\n\n### Development Deployment\n\nDevelopment deployment uses self-signed certificates and is intended for local development.\n\n```bash\n# Set development environment in the Makefile\n# DEVELOPMENT_ENVIRONMENT := true (default)\n\n# Build and start containers\nmake build\nmake up\n\n# View logs\nmake logs\n\n# Stop containers\nmake down\n```\n\n### Production Deployment\n\nProduction deployment uses Let's Encrypt for SSL certificates and is intended for production use.\n\n```bash\n# Set production environment in the Makefile\n# Edit the Makefile and set:\n# DEVELOPMENT_ENVIRONMENT := false\n\n# Build and start containers\nmake build\nmake up\n\n# View logs\nmake logs\n\n# Stop containers\nmake down\n```\n\n### Environment Configuration\n\nConfigure the deployment by editing `.devcontainer/.env`:\n\n- `DOMAIN`: Set your domain (e.g., mydomain.com for production or dev.localhost for development)\n  - Default for development: `dev.localhost`\n- Database settings\n- Other application settings\n\n### Database Management\n\n```bash\n# Run database migrations\nmake migrate\n\n# Check migration status\nmake migrate-status\n\n# View pending migrations\nmake migrate-pending\n\n# Access database shell\nmake shell-db\n```\n\n### Application Management\n\n```bash\n# Access application shell\nmake shell-app\n\n# Restart services\nmake restart\n\n# Clean up environment (removes volumes and containers)\nmake clean\n\n# Start the application with migrations\nmake start-app\n\n# Test services and HTTPS connectivity\nmake test\n```\n\n### Testing Services\n\nThe project includes a convenient command to test if all services are running properly and accessible via HTTPS:\n\n```bash\nmake test\n```\n\nThis command performs the following checks:\n\n- Validates all running services (containers)\n- Tests the database connection\n- Verifies HTTPS connectivity to:\n  - Frontend interface\n  - Backend API\n  - PGAdmin database management\n- Checks the status of the Traefik proxy\n- Provides a summary of running vs. expected services\n\nThe tests use the domain configured in your `.devcontainer/.env` file and include support for self-signed certificates.\n\n## Project Structure\n\n- `backend/`: FastAPI application\n- `frontend/`: Astro frontend application\n- `.devcontainer/`: Docker configuration files\n  - `docker-compose.yaml`: Production Docker Compose configuration\n  - `docker-compose.dev.yaml`: Development Docker Compose configuration\n  - `Dockerfile.backend`: Backend container configuration\n  - `Dockerfile.frontend`: Frontend container configuration\n\n## Available Services\n\n- Frontend: `https://{DOMAIN}/`\n- Backend API: `https://{DOMAIN}/api/`\n- PostgreSQL Database Management: `https://{DOMAIN}/db/`\n- Traefik Dashboard (if enabled): `https://{DOMAIN}/dashboard/`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecsrayo%2Fhomeprice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodecsrayo%2Fhomeprice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecsrayo%2Fhomeprice/lists"}