{"id":13431290,"url":"https://github.com/timwis/enviar","last_synced_at":"2025-09-21T01:31:56.430Z","repository":{"id":57225983,"uuid":"64841546","full_name":"timwis/enviar","owner":"timwis","description":"Chat interface for SMS / text messages","archived":false,"fork":false,"pushed_at":"2022-09-25T20:27:09.000Z","size":130,"stargazers_count":38,"open_issues_count":31,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T05:39:26.182Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/timwis.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}},"created_at":"2016-08-03T11:39:07.000Z","updated_at":"2025-03-06T07:48:06.000Z","dependencies_parsed_at":"2022-08-24T11:00:36.718Z","dependency_job_id":null,"html_url":"https://github.com/timwis/enviar","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/timwis/enviar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timwis%2Fenviar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timwis%2Fenviar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timwis%2Fenviar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timwis%2Fenviar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timwis","download_url":"https://codeload.github.com/timwis/enviar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timwis%2Fenviar/sbom","scorecard":{"id":886962,"data":{"date":"2025-08-11","repo":{"name":"github.com/timwis/enviar","commit":"c823ba7fa459327c2305b8d904d4c7ec1d003c2e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 1/20 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 12 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-24T10:22:35.653Z","repository_id":57225983,"created_at":"2025-08-24T10:22:35.653Z","updated_at":"2025-08-24T10:22:35.653Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276183680,"owners_count":25599223,"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":"2025-09-20T02:00:10.207Z","response_time":63,"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":[],"created_at":"2024-07-31T02:01:01.978Z","updated_at":"2025-09-21T01:31:56.130Z","avatar_url":"https://github.com/timwis.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Projects using yo-yo","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# enviar\n\nReal-time, multi-user chat interface for SMS / text messages. Imagine a call center where customers can\nsend a text message to a single number and have a live chat with any agent(s) available.\n\n![screenshot](http://i.imgur.com/PIRyygi.png)\n\n## Installation\nYou can run enviar entirely on free hosted platforms: [Heroku](https://heroku.com)\nfor the application and [Cloudant](https://cloudant.com) for the database. But\nyou may prefer to run it locally or on your own server.\n\n### Account credentials\nTo use enviar in production, you'll need a [Twilio](http://twilio.com) account\nfor sending SMS and a [Postmark](http://postmarkapp.com) account for sending\npassword reset emails. If you're setting enviar up for production, I recommend\ncreating those ahead of time because you'll need your twilio account's\n\"Account SID\" and \"Auth Token\", and your postmark account's \"server token\" as\npart of the application install process. If you're not setting up enviar for\nproduction, you can skip this part for now.\n\n### Free hosted installation\n\n#### Database\nYou can use [Cloudant's](https://cloudant.com) free tier for the database by\nsetting up an account there. Create a database called `enviar` once you've signed up.\n\n#### Application\nYou can run the application on [Heroku's](https://heroku.com) free tier.\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\nFill in the parameters from the accounts you've setup, including your Cloudant\naccount in the `COUCHDB` settings.\n\nYou should be able to view your application at `https://\u003capp-name\u003e.herokuapp.com`\nand login using your Cloudant credentials.\n\n### Local / self-hosted\n\n#### Database\nThis application uses CouchDB to store messages. Follow their [install docs](http://docs.couchdb.org/en/1.6.1/install/index.html)\nto run CouchDB locally.\n\nBy default, CouchDB considers everyone an admin, which is known as \"Admin Party.\"\nDisable this by going to the control panel (usually at `http://localhost:5984/_utils`)\nand [disabling it](http://i.imgur.com/CNtlaBK.png) (image credit @nolanlawson).\nIn doing so, you'll create your admin account with a password.\n\n#### Application\n1. Clone this repo using `git clone https://github.com/timwis/enviar.git`\n2. Install node dependencies via `npm install`\n3. Copy `.env.sample` to `.env`\n4. Fill in your the `COUCHDB_HOST` in `.env` (ie. `http://localhost:5984`), along\nwith the `COUCHDB_USER` and `COUCHDB_PASS` you setup. The other variables are only\nrequired in production mode.\n5. Enable [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS)\nby running `npm run cors` from the terminal\n\n## Usage\n\n### Development mode\n1. Run the server using `NODE_ENV=development npm start`\n2. Access the server at `http://localhost:3000`\n\nYou can simulate sending messages using the interface. To simulate receiving a message,\nsend a `POST` request to `http://localhost:3000/api/inbound`.\n\nSample inbound `POST` request: (note the `+` in the phone number is encoded as `%2B`)\n\n```bash\ncurl -X POST -d 'SmsSid=123456\u0026From=%2B12597150948\u0026Body=hello' http://localhost:3000/api/inbound\n```\n\n### Production mode\n1. Make sure all the credentials are filled out in `.env`\n2. Run the server using `npm start`\n3. Point twilio's incoming message webhook to `http://\u003cyour-server\u003e/api/inbound` (check out [ngrok](https://ngrok.com/) to expose your localhost)\n\nAccess the server at `http://\u003cyour-server\u003e:3000` (override port using `PORT` environment variable)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimwis%2Fenviar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimwis%2Fenviar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimwis%2Fenviar/lists"}