{"id":19035744,"url":"https://github.com/FreeClimbAPI/Java-Messaging-Quickstart","last_synced_at":"2025-04-17T14:33:20.844Z","repository":{"id":51692915,"uuid":"241973852","full_name":"FreeClimbAPI/Java-Messaging-Quickstart","owner":"FreeClimbAPI","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-09T22:19:02.000Z","size":34,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-09T22:42:38.846Z","etag":null,"topics":["messaging","tutorial"],"latest_commit_sha":null,"homepage":null,"language":"Java","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/FreeClimbAPI.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}},"created_at":"2020-02-20T19:41:22.000Z","updated_at":"2025-01-09T22:19:06.000Z","dependencies_parsed_at":"2025-01-09T23:23:11.848Z","dependency_job_id":"2b24e2d0-6dd3-46ca-9271-ea1df1a5d38c","html_url":"https://github.com/FreeClimbAPI/Java-Messaging-Quickstart","commit_stats":null,"previous_names":["freeclimbapi/java-sms-quickstart"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FJava-Messaging-Quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FJava-Messaging-Quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FJava-Messaging-Quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FJava-Messaging-Quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FreeClimbAPI","download_url":"https://codeload.github.com/FreeClimbAPI/Java-Messaging-Quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249348700,"owners_count":21255306,"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":["messaging","tutorial"],"created_at":"2024-11-08T21:51:58.524Z","updated_at":"2025-04-17T14:33:20.839Z","avatar_url":"https://github.com/FreeClimbAPI.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Java Messaging Quickstart\n\nThis quickstart serves as a guide to get your first Messaging application up and running with [FreeClimb](https://docs.freeclimb.com/docs/how-freeclimb-works).\n\nSpecifically, the project will:\n\n- Receive an incoming message via a FreeClimb application\n- Respond \"Hello World!\" to the incoming message\n\n## Tutorial\n\nWe offer a [Java Messaging Quickstart Tutorial](https://docs.freeclimb.com/docs/java-messaging-quickstart) for more detailed set-up instructions and explanation of how FreeClimb works.\n\n## Requirements\nA [FreeClimb account](https://www.freeclimb.com/dashboard/signup/)\n\nA [registered application](https://docs.freeclimb.com/docs/registering-and-configuring-an-application#register-an-app) with a named alias\n\nA [configured FreeClimb number](https://docs.freeclimb.com/docs/getting-and-configuring-a-freeclimb-number) assigned to your application\n\nTrial accounts: a [verified number](https://docs.freeclimb.com/docs/using-your-trial-account#verifying-outbound-numbers)\n\nTools:\n- [Java](https://www.oracle.com/java/technologies/downloads/) 8 or higher\n- [ngrok](https://ngrok.com/download) (recommended for hosting)\n- [Gradle](https://gradle.org/install/)\n\n## Setting up the Quickstart\n\n1. Configure environment variables (in `.env.sample` and rename the file to `.env`):\n\n   | ENV VARIABLE     | DESCRIPTION                                                                                                                            |\n   | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n   | ACCOUNT_ID       | Account ID which can be found under [API credentials](https://www.freeclimb.com/dashboard/portal/account/authentication) in dashboard. |\n   | API_KEY          | API key which can be found under [API credentials](https://www.freeclimb.com/dashboard/portal/account/authentication) in dashboard.    |\n   | FREECLIMB_NUMBER | The number that sends messages from your application. Your FreeClimb number.                                                           |\n\n2. Make your local server publicly accessible\n    ```bash\n    ngrok http 3000\n    ```\n    Once you run ngrok you should receive a response with a public URL, that looks something like 'https://ba1c-63-209-137-19.ngrok-free.app'. \n\n3. [Configure your applications's endpoints](https://docs.freeclimb.com/docs/registering-and-configuring-an-application#configure-your-application) by adding a publicly accessible URL (we recommend an [ngrok](https://ngrok.com/download) URL) and the route reference `/incomingSms` to your App Config's SMS URL field:\n\n    ```bash\n    https://YOUR-URL.ngrok.io/incomingSms\n    ```\n    \n## Running the Quickstart\n1. Start your voice quickstart application\n\n    ```bash\n    gradle build \u0026\u0026 java -Dserver.port=3000 -jar build/libs/Java-SMS-Quickstart-plain.jar\n    ```\n\n2. Call the FreeClimb number assigned to the application you've configured for this tutorial \n\n## Using Docker to Run the Quickstart\n\n1. Pull docker image from dockerhub\n\n   ```bash\n   docker pull freeclimbapi/java-sms-quickstart\n   ```\n\n2. Run docker image after replacing placeholder values\n\n   ```bash\n   docker run -e ACCOUNT_ID=\u003cYOUR_ACCOUNT_ID\u003e -e API_KEY=\u003cYOUR_API_KEY\u003e -e FREECLIMB_NUMBER=\u003cYOUR_FREECLIMB_NUMBER\u003e -p 3000:3000 freeclimbapi/java-sms-quickstart\n   ```\n\n## Feedback \u0026 Issues\nIf you would like to give the team feedback or you encounter a problem, please [contact support](https://www.freeclimb.com/support/) or [submit a ticket](https://freeclimb.com/dashboard/portal/support) in the dashboard.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFreeClimbAPI%2FJava-Messaging-Quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFreeClimbAPI%2FJava-Messaging-Quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFreeClimbAPI%2FJava-Messaging-Quickstart/lists"}