{"id":35886843,"url":"https://github.com/anmamuncoder/multi-shop-management-backend","last_synced_at":"2026-01-08T21:03:13.084Z","repository":{"id":331350231,"uuid":"1126216591","full_name":"anmamuncoder/multi-shop-management-backend","owner":"anmamuncoder","description":"A modern Django-based shop management platform with async task processing, built for scalability and performance.","archived":false,"fork":false,"pushed_at":"2026-01-05T12:19:18.000Z","size":237,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-06T19:54:32.067Z","etag":null,"topics":["celery","django","doc","factory-boy","postgresql","pytest","redis","rest-api","unittest","websocket"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anmamuncoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-01T12:10:02.000Z","updated_at":"2026-01-06T17:51:05.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/anmamuncoder/multi-shop-management-backend","commit_stats":null,"previous_names":["anmamuncoder/multi-shop-management-backend"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/anmamuncoder/multi-shop-management-backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmamuncoder%2Fmulti-shop-management-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmamuncoder%2Fmulti-shop-management-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmamuncoder%2Fmulti-shop-management-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmamuncoder%2Fmulti-shop-management-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anmamuncoder","download_url":"https://codeload.github.com/anmamuncoder/multi-shop-management-backend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmamuncoder%2Fmulti-shop-management-backend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28248937,"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","status":"online","status_checked_at":"2026-01-08T02:00:06.591Z","response_time":241,"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":["celery","django","doc","factory-boy","postgresql","pytest","redis","rest-api","unittest","websocket"],"created_at":"2026-01-08T21:01:58.704Z","updated_at":"2026-01-08T21:03:13.078Z","avatar_url":"https://github.com/anmamuncoder.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shop Management System\n\nA modern Django-based shop management platform with async task processing, built for scalability and performance.\n\n##  Features \n\n\u003e **Product Management** – Product catalog, categories, variants, images, inventory, search, and filtering   \u003cbr\u003e\n\u003e **Order Processing** – End-to-end order lifecycle including placement, tracking, cancellation, and fulfillment   \u003cbr\u003e\n\u003e **User Accounts** – Secure authentication, role-based access, profile management, OTP, and email verification  \u003cbr\u003e\n\u003e **Transactions \u0026 Payments** – Wallet top-ups, admin bank access, transaction history, and financial tracking  \u003cbr\u003e\n\u003e **Real-time Chat** – Instant messaging with chat channels and real-time communication support  \u003cbr\u003e\n\u003e **Messaging \u0026 Campaigns** – Email, SMS, WhatsApp, and notification templates with campaign and log management  \u003cbr\u003e\n\u003e **Background Tasks** – Asynchronous processing using Celery for emails, notifications, and heavy jobs  \u003cbr\u003e\n\u003e **Database** – Robust and scalable data storage powered by **PostgreSQL**  \u003cbr\u003e\n\u003e **RESTful API** – OpenAPI-compliant, frontend-ready REST APIs with modular documentation   \u003cbr\u003e\n\n\u003e **Security** – JWT authentication, role-based access control (RBAC), and permission enforcement  \u003cbr\u003e \n\u003e **Caching \u0026 Performance** – Redis-based caching for fast, scalable API performance  \u003cbr\u003e\n\u003e **Validation \u0026 Error Handling** – Centralized request validation and consistent API error responses   \u003cbr\u003e\n\u003e **Pagination \u0026 Filtering** – Optimized data retrieval for large datasets   \u003cbr\u003e\n\u003e **Logging \u0026 Monitoring** – Structured logs and activity tracking for debugging and auditing   \u003cbr\u003e\n\n## Prerequisites \n\n- **Docker** 20.10+\n- **Docker Compose** 2.0+\n- **Git** (latest stable version recommended)  \n- **Daphne** (ASGI server for running the application)\n\n\u003cbr\u003e\n\n## ⚡ Quick Start\n\n### 1. Clone \u0026 Setup\n\n```bash\ngit clone https://github.com/VTS-learn/team-setu-be.git\ncd team-setu-be\n```\n\n### 2. Configure Environment\n\nCreate `.env` file in project root:\n\n```env\n# Server Configuration\n\nCOMPOSE_PROJECT_NAME=multi_shop_management\n\nWEB_PORT=8020\nDEBUG=True\nALLOWED_HOSTS=localhost,127.0.0.1\nSECRET_KEY=django-insecure-kq^st_dx6s-%fn-x-xyjacw1t@rph0-bfv9i-op!w$=eci)sfw\n\n# Database\nPOSTGRES_DB=multi_shop_management_db\nPOSTGRES_USER=postgres\nPOSTGRES_PASSWORD=your-secure-password\nPOSTGRES_HOST=db\nPOSTGRES_PORT=5432\n\n# EMAIL CONFIGURATION\nEMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend\nEMAIL_HOST=smtp.gmail.com\nEMAIL_PORT=587\nEMAIL_USE_TLS=True\nEMAIL_USE_SSL=False\nEMAIL_HOST_USER=your-email-address\nEMAIL_HOST_PASSWORD=your-email-app-secure-password\n\n# Redis \u0026 Celery\nCELERY_BROKER_URL=redis://redis:6379/0\nCELERY_RESULT_BACKEND=redis://redis:6379/1\n\n#  MISC SETTINGS \nTIME_ZONE=Asia/Dhaka\nLANGUAGE_CODE=en-us\n```\n\n### 3. Launch Application\n\n```bash\n# Build containers\ndocker compose -f docker-compose-dev.yml build\n\n# Start services\ndocker compose -f docker-compose-dev.yml up -d\n\n# Run migrations\ndocker compose -f docker-compose-dev.yml exec web python manage.py migrate\n\n# Create admin user\ndocker compose -f docker-compose-dev.yml exec web python manage.py createsuperuser\n```\n\n### 4. Access Application\n\n- **API/Web:** http://localhost:8020\n- **Admin Panel:** http://localhost:8020/admin\n\n\u003cbr\u003e\n\n---\n\n\u003cbr\u003e\n\n### 5.  Location of API Docs OpenAPI 3.0 specification\n \n#### **How to View the API Documentation**\n\nYou can load the file directly in Swagger Online Editor: \u003cbr\u003e\n🔗 **Swagger Online Editor** [editor.swagger.io](https://editor.swagger.io/)\n\n**Steps:**\n\n1. Open the Swagger Editor link above.\n2. On the top menu, click **File → Import File → Paste JSON/YAML**.\n3. Open the `docs/*.yml` file from this repository on GitHub.\n4. Copy the entire contents of the YAML file.\n5. Paste it into the Swagger Editor.\n6. The interactive API documentation will load automatically.\n\n\u003cbr\u003e\n\n```shell\ndocs/\n├── authentication.yml       # Authentication APIs (9 endpoints)\n│                             # Login, Register, OTP, Email Verification, Password Reset, Token Refresh, Profile Data etc.\n│\n├── shop_public.yml           # Public Shop APIs (10 endpoints)\n│                             # public Shop listing \u0026 details, product category, product variant, product image, product view, search, filter, etc. \n│\n├── shop_owner.yml            # Shop Owner APIs (29 endpoints)\n│                             # Shop management, product CRUD, category CRUD, product variant CRUD, product images CRUD\n│\n├── order_customer.yml        # Customer Order APIs (12 endpoints)\n│                             # Place order, order items,  order history, order details, cancel order, etc.\n│\n├── order_owner.yml           # Shop Owner Order APIs (5 endpoints)\n│                             # View orders, update order status, order processing\n│\n├── transactions.yml          # Transaction APIs (6 endpoints)\n│                             # View Admin Bank Account, Shop Owner TopUp, transaction history, \n│\n├── template_messaging.yml    # Messaging Template APIs (18 endpoints)\n│                             # CRUD Email/SMS/Notification/WhatsApp templates, campaign CRUD, Log preview, All Customer View\n│\n├── real_time_chat.yml        # Real-time Chat APIs (5 endpoints)\n│                             # Chat Channel, Chat messages, real-time communication\n```\n\n \n## Quick Stats\n\n| Category | Endpoint Count | Documentation |\n|----------|---------------|---------------|\n| Authentication | 9 | [`authentication.yml`](./authentication.yml) |\n| Shop Public | 10 | [`shop_public.yml`](./shop_public.yml) |\n| Shop Owner | 29 | [`shop_owner.yml`](./shop_owner.yml) |\n| Order Customer | 12 | [`order_customer.yml`](./order_customer.yml) |\n| Order Owner | 5 | [`order_owner.yml`](./order_owner.yml) |\n| Transactions | 6 | [`transactions.yml`](./transactions.yml) |\n| Template Messaging | 18 | [`template_messaging.yml`](./template_messaging.yml) |\n| Real-Time Chat | 5 | [`real_time_chat.yml`](./real_time_chat.yml) |\n| **Total** | **94** | - |\n\n\n\n\u003cbr\u003e\n\n---\n\n\u003cbr\u003e\n\n\n## 🖥 CMS App - Admin Dashboard\n\nThis app manages the **homepage content** of the website. It is **backend-only** and does **not provide APIs**. Content is managed via the Django admin and rendered in the frontend templates.\n\n### Features\n\n- **Wireframe** – Manage website branding and social media links.  \n- **Testimonials** – Add and display user or customer feedback.  \n- **FAQs** – Maintain frequently asked questions and answers for the homepage.  \n- **Features** – Define homepage features with title, description, and pricing.\n\n### Admin Access\n\n- Navigate to `/admin` after logging in as a superuser or staff.  \n- The dashboard provides access to the above sections:\n\n\n\u003e All content is handled through the Django admin interface. These models are used for rendering the homepage and other frontend sections.\n\n\u003cbr\u003e\n\n---\n\n\u003cbr\u003e\n\n## 📁 Project Structure\n\n```\nteam-setu-be/\n├── apps/\n│   ├── base/           # Core functionality\n│   ├── accounts/       # User management\n│   ├── store/          # Product catalog\n│   ├── order/          # Order processing\n│   ├── chat/          # Customer vs Owner Chat\n│   ├── transaction/          # Transaction system\n│   ├── messaging/          # Template messaging\n│   └── cms/          # content management system\n├── core/\n│   ├── settings.py     # Django configuration\n│   └── asgi.py         # ASGI config\n├── docs/ \n│   └── openapi.yml     # API Documentation\n├── media/\n│   └── All Media Files\n├── templates/\n│   └── All Templates\n├── .env\n├── .gitignore\n├── docker-compose-dev.yml\n├── Dockerfile.dev\n├── Dockerfile.prod\n├── requirements.txt \n├── pytest.ini\n└── manage.py\n```\n\n\n## 🔧 Development\n\n### Essential Commands\n\n```bash\n# Start development environment\ndocker compose -f docker-compose-dev.yml up\n\n# View logs\ndocker compose -f docker-compose-dev.yml logs -f web\n\n# Run migrations\ndocker compose -f docker-compose-dev.yml exec web python manage.py migrate\n\n# Create migrations\ndocker compose -f docker-compose-dev.yml exec web python manage.py makemigrations\n\n# Create super/staff/admin user\ndocker compose -f docker-compose-dev.yml exec web python manage.py createsuperuser\n\n# Django shell\ndocker compose -f docker-compose-dev.yml exec web python manage.py shell\n\n# Stop all services\ndocker compose -f docker-compose-dev.yml down\n```\n\n### Database Operations\n\n```bash\n# Backup\ndocker compose -f docker-compose-dev.yml exec db pg_dump -U postgres multi_shop_management \u003e backup.sql\n\n# Restore\ncat backup.sql | docker compose -f docker-compose-dev.yml exec -T db psql -U postgres multi_shop_management\n\n# Access database\ndocker compose -f docker-compose-dev.yml exec db psql -U postgres -d multi_shop_management\n```\n\n\n\n## Support\n\n- 📧 Contact development team\n- 🐛 [Report issues](https://github.com/anmamuncoder/)\n- 📖 Check documentation\n\n---\n\n**Built with , using Django, PostgreSQL, Redis, and Celery**\n \n\u003e [`Author`](https://github.com/anmamuncoder)\n\u003e [`Project`](https://github.com/VTS-learn/team-setu-be.git)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanmamuncoder%2Fmulti-shop-management-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanmamuncoder%2Fmulti-shop-management-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanmamuncoder%2Fmulti-shop-management-backend/lists"}