{"id":15658388,"url":"https://github.com/pradumnasaraf/post-my-message","last_synced_at":"2025-05-04T08:37:28.335Z","repository":{"id":56864031,"uuid":"526622167","full_name":"Pradumnasaraf/Post-My-Message","owner":"Pradumnasaraf","description":"Send sms or a beautiful quote to your friend by a simple POST request.","archived":false,"fork":false,"pushed_at":"2023-06-26T18:39:01.000Z","size":178,"stargazers_count":24,"open_issues_count":0,"forks_count":16,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-19T09:58:38.009Z","etag":null,"topics":["axios","express","javascript","nodejs","sms","twilio","twilio-api"],"latest_commit_sha":null,"homepage":"https://post-my-message.vercel.app","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/Pradumnasaraf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["eddiejaoude"]}},"created_at":"2022-08-19T13:38:18.000Z","updated_at":"2025-01-02T13:15:23.000Z","dependencies_parsed_at":"2024-10-23T05:48:01.072Z","dependency_job_id":null,"html_url":"https://github.com/Pradumnasaraf/Post-My-Message","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FPost-My-Message","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FPost-My-Message/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FPost-My-Message/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pradumnasaraf%2FPost-My-Message/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pradumnasaraf","download_url":"https://codeload.github.com/Pradumnasaraf/Post-My-Message/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252136905,"owners_count":21700097,"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","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":["axios","express","javascript","nodejs","sms","twilio","twilio-api"],"created_at":"2024-10-03T13:12:18.993Z","updated_at":"2025-05-03T03:19:55.273Z","avatar_url":"https://github.com/Pradumnasaraf.png","language":"JavaScript","funding_links":["https://github.com/sponsors/eddiejaoude"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://github.com/Pradumnasaraf/Post-My-Message/assets/51878265/e16f2cc8-f247-48d5-ace0-abf65d2bfb7c\" alt = \"post my message banner\"\u003e\n\n\u003ch4\u003eSend sms or a beautiful quote to your friend by a simple POST request.\u003c/h4\u003e\n\n[![Format](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/prettier.yml/badge.svg)](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/prettier.yml) [![Publish Image to GitHub Container Registry](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/publish-ghcr.yml/badge.svg)](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/publish-ghcr.yml) [![Linter](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/linter.yml/badge.svg)](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/linter.yml) [![Releases](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/releases.yml/badge.svg)](https://github.com/Pradumnasaraf/Post-My-Message/actions/workflows/releases.yml)\n\n\u003c/div\u003e\n\n## 👨‍💻 Tech stack\n\n- [Node.js](https://nodejs.org/en/)\n- [Express.js](https://expressjs.com/)\n- [Twilio](https://www.twilio.com/)\n- [Vercel](https://vercel.com/)\n\n## 🛠️ Using the Routes\n\nAfter deploying the API the request will be on {API_BASE_URL}/{route}. This project is deployed with the base URL as [https://post-my-message.vercel.app](https://post-my-message.vercel.app).\n\n**Send a custom message to a number - `/sendsms` POST method.**\n\nIt sends a custom message to the number provided. The request body should have a `\"phone\"` and `\"message\"`property that contains the receiver's number and a message. The POST body should be in JSON format.\n\n\u003c!-- Note: Sender's number will be your Twilio number, which you configure in the [.env](/.env_sample) --\u003e\n\n```JSON\n{\n    \"message\": \"Hey, this message is from Twilio\",\n    \"phone\": \"+111111111111\"\n}\n```\n\n**Send a random quote to a number - `/sendquote` POST method.**\n\nIt sends a random quote to the number provided. The request body should have a `\"phone\"` property that contains the receiver's number. The POST body should be in JSON format.\n\n```JSON\n{\n    \"phone\": \"+111111111111\"\n}\n```\n\n## 👨‍💻 Developing the API\n\nThis section includes how to test and develop API at your end. You can either run it in the cloud using **Gitpod** or run it inside a container using **docker** or choose to set up the complete environment locally.\n\n**GitPod**\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Pradumnasaraf/Post-My-Message)\n\n**Docker Compose**\n\nPrerequisites - Docker and Compose installed in your local system.\n\n\u003e NOTE: First add the the environment variables to the `.env.example` file.\n\nYou can run below command and you can access the API at `localhost:9001`\n\n```bash\ndocker compose up\n```\n\n**Local setup**\n\nPrerequisites- Node.js installed and a Mongo server on your localhost.\n\n\u003e NOTE: First add the the environment variables to the `.env.example` file.\n\nStep 1: Copy `.env.example` to `.env`.\n\n```\nnpm run env\n```\n\nStep 2: Run the app in development mode.\n\n```\nnpm run dev\n```\n\nYou can access the API at localhost:9001\n\n## 🛡️ License\n\nThis project is licensed under the GPL-3.0 license - see the [LICENSE](LICENSE) file for details\n\n## 🤝 Support\n\nIf you liked the project, please consider giving it a ⭐️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradumnasaraf%2Fpost-my-message","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpradumnasaraf%2Fpost-my-message","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradumnasaraf%2Fpost-my-message/lists"}