{"id":18484415,"url":"https://github.com/giveth/giveth-toshi-app","last_synced_at":"2025-04-08T18:33:24.247Z","repository":{"id":66358880,"uuid":"111445823","full_name":"Giveth/giveth-toshi-app","owner":"Giveth","description":"Giveth's Toshi chat bot app","archived":true,"fork":false,"pushed_at":"2023-02-15T16:20:43.000Z","size":655,"stargazers_count":4,"open_issues_count":1,"forks_count":5,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-02-22T22:23:53.108Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Giveth.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}},"created_at":"2017-11-20T18:11:38.000Z","updated_at":"2024-12-31T10:24:24.000Z","dependencies_parsed_at":"2023-02-23T04:45:32.863Z","dependency_job_id":null,"html_url":"https://github.com/Giveth/giveth-toshi-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giveth%2Fgiveth-toshi-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giveth%2Fgiveth-toshi-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giveth%2Fgiveth-toshi-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giveth%2Fgiveth-toshi-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Giveth","download_url":"https://codeload.github.com/Giveth/giveth-toshi-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247902860,"owners_count":21015535,"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":[],"created_at":"2024-11-06T12:39:45.735Z","updated_at":"2025-04-08T18:33:24.225Z","avatar_url":"https://github.com/Giveth.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Toshi SOFA App\n\nThis repo helps you build a [Toshi app](https://www.toshi.org) in Javascript.\n\nThe sample bot can:\n\n* send messages\n* send and request money\n* create simple UI for buttons and menus\n* store sessions and state for each user\n\nTODO\n\n* sending image messages\n* creating web view UIs\n\n## Launch your own Toshi app in 5 minutes\n\nRead our [guide to creating a Toshi app](http://developers.toshi.org/docs/creating-a-token-app).\n\nWhen ready, fork this repo and deploy it to Heroku.\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\nThen check out [`src/bot.js`](src/bot.js) to start changing the bot logic.\n\n## Running locally with Docker\n\nYou can run the project locally with\n\n```\ndocker-compose up\n```\n\nIf any new depencies are added you can rebuild the project with\n\n```\ndocker-compose build\n```\n\nTo reset the postgres database in your dev environment you can use\n\n```\ndocker-compose down -v\n```\n\n## Architecture\n\nDeploying a Toshi app requires a few processes to run:\n\n* **toshi-headless-client**\u003cbr\u003e\n  This is a client we provide (similar to the iOS or Android client) that provides a wrapper around the Toshi backend services. It also handles end-to-end encrypting all messages using the Signal protocol. It is written in Java and runs in the background, proxying all the requests to and from your bot.\n* **redis**\u003cbr\u003e\n  We use redis pub/sub to provide a connection between the toshi-headless-client and your bot.\n* **bot.js**\u003cbr\u003e\n  This is where all your app logic lives.\n* **postgres**\u003cbr\u003e\n  Postgres is used to store session data so you can persist state for each user who talks to your bot (similar to cookies in a web browser).\n\n![diagram](docs/images/app-architecture.png)\n\n## See also\n\n* [https://www.toshi.org]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiveth%2Fgiveth-toshi-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiveth%2Fgiveth-toshi-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiveth%2Fgiveth-toshi-app/lists"}