Skip to content

Gudvin82/smartwidget-showcase

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SmartWidget AI + CRM (Showcase Edition)

Public showcase repository of SmartWidget: embeddable AI chat widget + browser admin panel + CRM-ready backend.

This edition is prepared for portfolio/review purposes:

  • safe for public GitHub
  • no production secrets
  • mock-friendly integration mode
  • clean quickstart for local demo

By default SHOWCASE_SANDBOX=1, so chat works without real provider keys.

What is included

  • backend/ FastAPI backend
  • backend/static/widget.js embeddable widget script
  • backend/static/admin.html admin panel UI
  • backend/.env.example safe environment template
  • backend/scripts/ smoke and operational scripts

What is intentionally not included

  • production .env
  • real database and runtime logs
  • private customer configurations
  • proprietary internal deployment details

Quickstart (local)

cd backend
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
uvicorn main:app --host 0.0.0.0 --port 8002

Open:

  • Widget demo: http://localhost:8002/static/demo.html
  • Admin panel: http://localhost:8002/static/admin.html

Embed example

<script
  defer
  src="https://YOUR-DOMAIN/static/widget.js"
  data-backend="https://YOUR-DOMAIN"
  data-title="Smart Assistant"
  data-subtitle="Online now"
  data-welcome="Здравствуйте! Чем могу помочь?"
></script>

API overview

  • POST /chat chat exchange
  • POST /lead lead capture
  • POST /callback callback request
  • GET /catalog catalog items
  • GET /health healthcheck
  • GET /api/widget-config runtime widget config

Architecture

See docs/ARCHITECTURE.md.

Reviewer / Partner Flow

  • Demo script: docs/DEMO_PLAYBOOK.md
  • Review checklist: docs/REVIEW_CHECKLIST.md
  • Feature matrix: docs/FEATURE_MATRIX.md
  • Screenshot guide: docs/SCREENSHOT_GUIDE.md
  • Embed examples: docs/EMBED_EXAMPLES.md

CI

  • Workflow: .github/workflows/showcase-ci.yml
  • Checks:
  • Python syntax/compile for core backend modules
  • Local app boot
  • Health/static/config HTTP checks
  • Smoke script execution

Deployment & Ops

  • On-prem guide: docs/DEPLOY_ONPREM.md
  • Cloud guide: docs/DEPLOY_CLOUD.md
  • Operations runbook: docs/OPERATIONS_RUNBOOK.md

License

This repository is distributed under a proprietary showcase license. See LICENSE.

Additional usage terms: NOTICE, docs/SHOWCASE_TERMS.md.

About

SmartWidget AI + CRM showcase edition

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors