{"id":23799869,"url":"https://github.com/martishin/speechpal-server","last_synced_at":"2025-09-06T13:33:15.861Z","repository":{"id":203371409,"uuid":"658136229","full_name":"martishin/speechpal-server","owner":"martishin","description":"Server code for speechpal.co, responsible the telegram bot and report functionalities","archived":false,"fork":false,"pushed_at":"2023-10-25T13:02:17.000Z","size":284,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-06T01:33:36.098Z","etag":null,"topics":["arrow-kt","flyway","jooq","kotlin","kotlin-coroutines","mongodb","postgresql","r2dbc","spring-boot","spring-webflux","telegram-bot"],"latest_commit_sha":null,"homepage":"https://speechpal.co/","language":"Kotlin","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/martishin.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}},"created_at":"2023-06-24T22:12:29.000Z","updated_at":"2025-01-10T11:47:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"b5e72eb5-ccf5-4f39-af76-4d8deb38f603","html_url":"https://github.com/martishin/speechpal-server","commit_stats":null,"previous_names":["ttymonkey/speechpal-server","tty-monkey/speechpal-server","data-tinker/speechpal-server","martishin/speechpal-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/martishin/speechpal-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martishin%2Fspeechpal-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martishin%2Fspeechpal-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martishin%2Fspeechpal-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martishin%2Fspeechpal-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martishin","download_url":"https://codeload.github.com/martishin/speechpal-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martishin%2Fspeechpal-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273912623,"owners_count":25189969,"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-06T02:00:13.247Z","response_time":2576,"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":["arrow-kt","flyway","jooq","kotlin","kotlin-coroutines","mongodb","postgresql","r2dbc","spring-boot","spring-webflux","telegram-bot"],"created_at":"2025-01-01T21:27:51.391Z","updated_at":"2025-09-06T13:33:15.516Z","avatar_url":"https://github.com/martishin.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SpeechPal Server\n\n\u003ca href=\"https://www.speechpal.co/\"\u003e\u003cimg src=\"./speechpal-logo.png\" width=\"250\"/\u003e\u003c/a\u003e\n\nThis repository hosts the backend code for the [SpeechPal](https://www.speechpal.co/) service, responsible the telegram bot and report functionalities.\n\n## 📌 Features\n- **Telegram Bot**: Interact with the SpeechPal service directly through Telegram. Check the bot [here](https://t.me/SpeechPalBot).\n- **Reports**: Access comprehensive reports about speech analysis. See a [sample report](https://www.speechpal.co/reports/AgAEOQAC0ZJASw).\n\n## 🚀 Running Locally\n\n### Prerequisites\n1. **Telegram Bot Token**: Obtain a token for your Telegram bot. See the [instructions](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key).\n2. **OpenAI API Key**: You'll need this key to access OpenAI functionalities. [Here's how](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key) to get it.\n3. **Databases**: Make sure you have PostgreSQL and MongoDB running locally. You can use Docker or any other method to start these services.\n\n### Starting the server\n1. In the root of the project, create a `.env` file with the following content:\n   ```\n   export BOT_TOKEN={YOUR_BOT_TOKEN}\n   export OPENAI_API_KEY={YOUR_OPENAI_API_KEY}\n   export OPENAI_ORG={YOUR_OPENAI_ORG}\n   export MONGO_DB_CONNECTION={YOUR_MONGO_DB_CONNECTION}\n   export MONGO_DB_DATABASE={YOUR_MONGO_DB_DATABASE}\n   export POSTGRESQL_DB_CONNECTION={YOUR_POSTGRESQL_DB_CONNECTION}\n   export POSTGRESQL_DB_USERNAME={YOUR_POSTGRESQL_DB_USERNAME}\n   export POSTGRESQL_DB_PASSWORD={YOUR_POSTGRESQL_DB_PASSWORD}\n   ```\n   Replace placeholders (like {YOUR_BOT_TOKEN}) with your actual values.\n2. Load your environment variables:\n   `source .env`\n3. To start the server, run:\n  `./gradlew bootRun`\n\n## ⚙️ Technologies Used\n- [Kotlin](https://kotlinlang.org/) with [coroutines](https://kotlinlang.org/docs/coroutines-overview.html)\n- [Gradle](https://gradle.org/)\n- [Spring WebFlux](https://docs.spring.io/spring-framework/reference/web/webflux.html)\n- [PostgreSQL](https://www.postgresql.org/)\n- [MongoDB](https://www.mongodb.com/)\n- [Spring Data R2DBC](https://spring.io/projects/spring-data-r2dbc)\n- [Arrow-KT](https://arrow-kt.io/)\n- [Flyway](https://flywaydb.org/)\n- [Jooq](https://www.jooq.org/)\n- [Testcontainers](https://testcontainers.com/)\n- [Telegram API client](https://github.com/kotlin-telegram-bot/kotlin-telegram-bot)\n- [OpenAI API client](https://github.com/aallam/openai-kotlin)\n- [Docker](https://www.docker.com/)\n- [Detekt](https://detekt.dev/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartishin%2Fspeechpal-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartishin%2Fspeechpal-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartishin%2Fspeechpal-server/lists"}