{"id":51115344,"url":"https://github.com/tyronejosee/project_marketly","last_synced_at":"2026-06-24T21:30:24.680Z","repository":{"id":321303223,"uuid":"1008024317","full_name":"tyronejosee/project_marketly","owner":"tyronejosee","description":"This repository implements a Django application following the principles of Clean Architecture and Domain-Driven Design (DDD). It serves as a practical example of how to structure a robust and maintainable application.","archived":false,"fork":false,"pushed_at":"2025-10-28T22:36:43.000Z","size":589,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2025-10-29T00:26:05.446Z","etag":null,"topics":["api-rest","django","django-rest-framework","docker","docker-compose","github-actions","httpx","pillow","postgresql","pre-commit-hooks","python","redis"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/repository/docker/tyronejose/marketly/general","language":"Python","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/tyronejosee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-24T22:57:12.000Z","updated_at":"2025-10-28T22:36:48.000Z","dependencies_parsed_at":"2025-10-29T00:26:10.241Z","dependency_job_id":"cee4817c-f3f2-4ef7-88e0-c77fadc80676","html_url":"https://github.com/tyronejosee/project_marketly","commit_stats":null,"previous_names":["tyronejosee/project_marketly"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/tyronejosee/project_marketly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyronejosee%2Fproject_marketly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyronejosee%2Fproject_marketly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyronejosee%2Fproject_marketly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyronejosee%2Fproject_marketly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tyronejosee","download_url":"https://codeload.github.com/tyronejosee/project_marketly/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyronejosee%2Fproject_marketly/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34750952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-24T02:00:07.484Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api-rest","django","django-rest-framework","docker","docker-compose","github-actions","httpx","pillow","postgresql","pre-commit-hooks","python","redis"],"created_at":"2026-06-24T21:30:23.965Z","updated_at":"2026-06-24T21:30:24.647Z","avatar_url":"https://github.com/tyronejosee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/tyronejosee/marketly\" target=\"_blank\"\u003e\n    \u003cimg src=\"docs/logo.svg\" alt=\"logo\" width=\"80\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\u003cstrong\u003eMarketly\u003c/strong\u003e\u003c/h1\u003e\n  \u003cspan\u003eEcommerce API\u003c/span\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\nThis repository implements a Django application following the principles of Clean Architecture and Domain-Driven Design (DDD). It serves as a practical example of how to structure a robust and maintainable application.\n\u003cp\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.python.org/\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/python-3.13-blue\" alt=\"python-version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.djangoproject.com/\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/django-5.0.1-green\" alt=\"django-version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.django-rest-framework.org/\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/drf-3.14.0-red\" alt=\"django-rest-framework-version\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## 📚 Documentation\n\n- 🧭 Product\n  - [Vision](./docs/product/vision.md)\n  - [Roadmap](./docs/product/roadmap.md)\n  - [Changelog](./docs/product/changelog.md)\n  - [Team](./docs/product/team.md)\n- ⚙️ Functional\n  - [Functional Specifications](./docs/functional/functional-specs.md)\n  - [Use Cases](./docs/functional/use-cases.md)\n  - [Glossary](./docs/functional/glossary.md)\n- 🏗️ Architecture/\n  - [System Overview](./docs/architecture/system-overview.md)\n  - [Components](./docs/architecture/components.md)\n  - [Database Schema](./docs/architecture/database-schema.md)\n  - [Security](./docs/architecture/security.md)\n- 📘 Architecture Decision Records (ADR)\n  - [0001 - Clean Architecture \u0026 DDD](./docs/architecture/adr/0001-clean-architecture-ddd.md)\n  - [0002 - Framework](./docs/architecture/adr/0002-framework.md)\n  - [0003 - Testing \u0026 Coverage](./docs/architecture/adr/0003-testing-coverage.md)\n  - [0004 - Environment Configuration](./docs/architecture/adr/0004-enviroment-configuration.md)\n  - [0005 - Docker](./docs/architecture/adr/0005-docker.md)\n  - [0006 - Linting \u0026 Code Formatting](./docs/architecture/adr/0006-linting-code-formatting.md)\n  - [0007 - Continuous Integration](./docs/architecture/adr/0007-continuous-integration.md)\n  - [0008 - JWT-based Authentication](./docs/architecture/adr/0008-jwt-based-authentication.md)\n  - [0009 - API Documentation](./docs/architecture/adr/0009-api-documentation.md)\n  - [0010 - Branching Strategy](./docs/architecture/adr/0010-branching-strategy.md)\n- 🚀 Operations\n  - [Local Setup](./docs/operations/local-setup.md)\n  - [Deployment](./docs/operations/deployment.md)\n  - [DevOps Guide](./docs/operations/devops-guide.md)\n  - [Environment Variables](./docs/operations/environment-variables.md)\n  - [Monitoring](./docs/operations/monitoring.md)\n- 🧪 Testing\n  - [Test Strategy](./docs/testing/test-strategy.md)\n  - [Coverage](./docs/testing/coverage.md)\n- 🤝 Contributing\n  - [Contributing Guide](./docs/contributing/contributing.md)\n  - [Commit Convention](./docs/contributing/commit-convention.md)\n  - [Code Style](./docs/contributing/code-style.md)\n\n## ⚙️ Installation\n\nClone the repository.\n\n```bash\ngit clone git@github.com:tyronejosee/project_marketly.git\ncd project_marketly\n```\n\n\u003e💡 We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) for this project. It is a fast, modern Python package manager that handles dependency resolution, virtual environments, and installs with superior performance and safety.\n\nInstall the project dependencies.\n\n```bash\nuv sync\n```\n\nCreate a copy of the `.env.example` file and rename it to `.env`.\n\n```bash\ncp .env.example .env\n```\n\n**Update the values of the environment variables (Important).**\n\n\u003e 💡 Make sure to correctly configure your variables before building the container.\n\n## 🐳 Docker\n\nBuild your container; it will take time the first time, as Docker needs to download all dependencies and build the image.\nUse the `-d` (detached mode) flag to start your containers in the background.\nUse the `--build` flag if you have changes and need to rebuild.\n\n```bash\ndocker compose up\ndocker compose up -d\ndocker compose up --build\n```\n\nStop the running containers (does not remove them).\n\n```bash\ndocker compose stop\n```\n\nStart previously created and stopped containers.\n\n```bash\ndocker compose start\n```\n\nShow container logs in real-time.\n\n```bash\ndocker compose logs -f\n```\n\nRestart a service with issues (Replace `\u003cservice_name\u003e`).\n\n```bash\ndocker compose restart \u003cservice_name\u003e\n```\n\nRemove your container.\n\n```bash\ndocker compose down\n```\n\n## 🐍 Django\n\nAccess the `web` service console that runs Django.\n\n```bash\ndocker compose exec web bash\n```\n\nInside the Django console, create the migrations.\n\n```bash\npython manage.py makemigrations\n```\n\nRun the migrations.\n\n```bash\npython manage.py migrate\n```\n\nIf you need to be more specific, use:\n\n```bash\npython manage.py migrate \u003capp_label\u003e \u003cmigration_name\u003e\n```\n\nList all available migrations and their status.\n\n```bash\npython manage.py showmigrations\n```\n\n\u003e 💡 Manually create the migration if Django skips an app; this happens because Django did not find the `/migrations` folder.\n\nCreate a superuser to access the entire site without restrictions.\n\n```bash\npython manage.py createsuperuser\n```\n\nLog in to `admin`:\n\n```bash\nhttp://127.0.0.1:8000/admin/\n```\n\nAccess Swagger or Redoc.\n\n```bash\nhttp://127.0.0.1:8000/api/schema/swagger/\nhttp://127.0.0.1:8000/api/schema/redoc/\n```\n\n## 🚨 Important Notes\n\nCheck the creation of migrations before creating them.\n\n```bash\ndocker compose exec web python manage.py makemigrations users\n```\n\n\u003e 💡 Checking migrations before their creation is necessary to avoid inconsistencies in user models.\n\n## 🐘 PostgreSQL\n\nAccess the PostgreSQL console.\n\n```bash\ndocker compose exec db psql -U postgres -d fandomhub_db\n```\n\nList all the tables in the database.\n\n```bash\n\\dt\n```\n\nShow the detailed structure of a specific table.\n\n```bash\n\\d \u003ctable_name\u003e\n```\n\nCreate a backup of your database (Optional).\n\n```bash\ndocker compose exec web python manage.py dumpdata \u003e backup.json\n```\n\nLoad the created backup if needed (Optional).\n\n```bash\ndocker compose exec web python manage.py loaddata\n```\n\n## 🧪 Testing\n\nRun all tests.\n\n```bash\npytest\n```\n\nRun tests for a specific domain.\n\n```bash\npytest tests/\u003cdomain\u003e\n```\n\nRun unit tests for a specific domain (with coverage).\n\n```bash\npytest tests/\u003cdomain\u003e -o addopts=\"--cov=src/modules/\u003cdomain\u003e --cov-report=term-missing\"\n```\n\n## ⚖️ License\n\nThis project is under the [MIT License](https://github.com/tyronejosee/project_marketly/blob/main/LICENSE).\n\nEnjoy! 🎉\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyronejosee%2Fproject_marketly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftyronejosee%2Fproject_marketly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyronejosee%2Fproject_marketly/lists"}