{"id":49613348,"url":"https://github.com/mrmeaow/devsms","last_synced_at":"2026-05-04T18:46:48.403Z","repository":{"id":340179914,"uuid":"1161314324","full_name":"mrmeaow/devsms","owner":"mrmeaow","description":"Local SMS testing inspired by Mailpit but for BD SMS service providers","archived":false,"fork":false,"pushed_at":"2026-02-23T19:50:37.000Z","size":159,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-24T00:28:55.921Z","etag":null,"topics":["bd-sms","devsms","docker","docker-image","ghcr-hosted","local-sms-bd","mahabub","mimsms","mrmeaow","pnpm-workspace","sms-api","sms-gateway"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrmeaow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-02-19T00:59:02.000Z","updated_at":"2026-02-23T20:02:49.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mrmeaow/devsms","commit_stats":null,"previous_names":["mrmeaow/devsms"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/mrmeaow/devsms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmeaow%2Fdevsms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmeaow%2Fdevsms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmeaow%2Fdevsms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmeaow%2Fdevsms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrmeaow","download_url":"https://codeload.github.com/mrmeaow/devsms/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmeaow%2Fdevsms/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32620523,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bd-sms","devsms","docker","docker-image","ghcr-hosted","local-sms-bd","mahabub","mimsms","mrmeaow","pnpm-workspace","sms-api","sms-gateway"],"created_at":"2026-05-04T18:46:45.980Z","updated_at":"2026-05-04T18:46:48.394Z","avatar_url":"https://github.com/mrmeaow.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# devsms\n\nGateway-neutral SMS inbox scaffold with:\n- `pnpm` monorepo\n- Express API server (`apps/server`)\n- SQLite canonical schema + JSON `meta`\n- Provider normalization stubs (`mimsms`, `twilio`, `smpp`)\n- SSE (`sms.new`) canonical event stream\n- Vite + React 19 inbox UI (`apps/web`)\n- Tailwind CSS v4 setup\n\n![Screenshot](./screenshot.png)\n\n---\n\n\n## Pull Image\n\n### Docker\n\n```bash\ndocker pull ghcr.io/mrmeaow/devsms:latest\n```\n\n### Podman\n\n```bash\npodman pull ghcr.io/mrmeaow/devsms:latest\n```\n\n---\n\n## Run Container\n\n### Docker\n\n```bash\ndocker run -d -p 4000:4000 -p 5153:5153 ghcr.io/mrmeaow/devsms:latest\n```\n\n## Workspace\n\n- `apps/server`: canonical message API + DB + SSE\n- `apps/web`: SSR React inbox client\n\n## Canonical Schema\n\nMigration: `apps/server/migrations/001_canonical_sms.sql`\n\nCore table: `sms_messages`\n- provider-neutral fields (`sender`, `recipient`, `body`, `status`, `direction`)\n- provider tracking (`provider`, `provider_message_id`)\n- flexible metadata (`encoding`, `parts`, `cost`, `currency`)\n- campaign fields (`campaign_id`, `transaction_type`)\n- compliance fields (`retention_policy`)\n- raw provider payload (`meta` JSON)\n\n## Run\n\n```bash\npnpm install\npnpm dev:server\npnpm dev:web\n```\n\nServer API: `http://localhost:4000`  \nWeb UI: `http://localhost:5153`\n\nSSR web server mode:\n\n```bash\npnpm --filter @devsms/web dev:ssr\n```\n\nSSR mode URL: `http://localhost:4173`\n\n## API\n\nHealth:\n\n```bash\ncurl http://localhost:4000/health\n```\n\nList inbox rows:\n\n```bash\ncurl \"http://localhost:4000/api/sms?limit=100\"\ncurl \"http://localhost:4000/api/sms?provider=mimsms\"\n```\n\nSSE stream:\n\n```bash\ncurl -N http://localhost:4000/api/events\n```\n\nDelivery simulation (`queued -\u003e delivered`):\n\n```bash\ncurl -X POST http://localhost:4000/api/sms/simulate-delivery\n```\n\n## Send Message Examples\n\nMiMSMS:\n\n```bash\ncurl -X POST http://localhost:4000/api/sms/send/mimsms \\\n  -H \"content-type: application/json\" \\\n  -d '{\n    \"SenderName\": \"GovOTP\",\n    \"MobileNumber\": \"8801712345678\",\n    \"Message\": \"OTP 1234\",\n    \"CampaignId\": \"campaign-1\",\n    \"TransactionType\": \"T\"\n  }'\n```\n\nTwilio:\n\n```bash\ncurl -X POST http://localhost:4000/api/sms/send/twilio \\\n  -H \"content-type: application/json\" \\\n  -d '{\n    \"From\": \"+12065550000\",\n    \"To\": \"+12065550123\",\n    \"Body\": \"Hello from Twilio stub\"\n  }'\n```\n\nSMPP:\n\n```bash\ncurl -X POST http://localhost:4000/api/sms/send/smpp \\\n  -H \"content-type: application/json\" \\\n  -d '{\n    \"source_addr\": \"8801700000000\",\n    \"destination_addr\": \"8801712345678\",\n    \"short_message\": \"SMPP test\",\n    \"data_coding\": 0\n  }'\n```\n\n## Status Mapping\n\nCanonical lifecycle:\n- `queued -\u003e sent -\u003e delivered`\n- `queued -\u003e failed`\n- `queued -\u003e expired`\n\nProvider mapping implemented in `apps/server/src/status-map.js`.\n\n## Docker\n\nBuild and run locally:\n\n```bash\ndocker build -t devsms:local .\ndocker run --rm -p 4000:4000 -p 5153:5153 devsms:local\n```\n\n- API: `http://localhost:4000`\n- Web (SSR): `http://localhost:5153`\n\n## CI / Image Publish\n\nGitHub Actions workflow: `.github/workflows/ci-image.yml`\n\n- Runs build checks on pull requests.\n- On push to `main` and tags (`v*`), builds Docker image and publishes to GHCR:\n  - `ghcr.io/\u003cowner\u003e/\u003crepo\u003e:\u003cbranch\u003e`\n  - `ghcr.io/\u003cowner\u003e/\u003crepo\u003e:sha-...`\n  - `ghcr.io/\u003cowner\u003e/\u003crepo\u003e:latest` (default branch only)\n\n## Kubernetes Example\n\n```yaml\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: devsms\nspec:\n  replicas: 1\n  selector:\n    matchLabels:\n      app: devsms\n  template:\n    metadata:\n      labels:\n        app: devsms\n    spec:\n      containers:\n        - name: devsms\n          image: ghcr.io/mrmeaow/devsms:latest\n          ports:\n            - containerPort: 4000\n            - containerPort: 5153\n```\n\n---\n\n## Image Provenance\n\nImages are built by GitHub Actions using Docker Buildx with layer caching.  \nImmutable images are available via SHA tags for reproducible deployments.\n\n\n## Contriutions\n\nYou're welcome to contribute! Fork it, work on it, make your PR, wait for my review.\n\n\u003e Must follow convensional git commits!\n\n**Made with :heart: by [mrmeaow](https://mrmeaow.netlify.app)**\n\n## LICENSE\n\n[GNU GENERAL PUBLIC LICENSE](./LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrmeaow%2Fdevsms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrmeaow%2Fdevsms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrmeaow%2Fdevsms/lists"}