{"id":21538387,"url":"https://github.com/rarimo/collabland-rarimo-poh-action","last_synced_at":"2025-03-17T20:47:50.276Z","repository":{"id":206041709,"uuid":"715643387","full_name":"rarimo/collabland-rarimo-poh-action","owner":"rarimo","description":"Implementation of the Collab.Land action /verify command for the Discord server which allows members to verify their humanity using the Rarimo Proof of Humanity case.","archived":false,"fork":false,"pushed_at":"2024-01-26T10:18:39.000Z","size":5011,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-24T07:46:08.137Z","etag":null,"topics":["collabland","proof-of-humanity","rarimo"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/rarimo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-11-07T14:48:41.000Z","updated_at":"2024-02-02T12:28:16.000Z","dependencies_parsed_at":"2024-01-26T12:22:46.444Z","dependency_job_id":null,"html_url":"https://github.com/rarimo/collabland-rarimo-poh-action","commit_stats":null,"previous_names":["rarimo/collabland-rarimo-poh-action"],"tags_count":6,"template":false,"template_full_name":"abridged/collabland-action-express","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fcollabland-rarimo-poh-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fcollabland-rarimo-poh-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fcollabland-rarimo-poh-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fcollabland-rarimo-poh-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rarimo","download_url":"https://codeload.github.com/rarimo/collabland-rarimo-poh-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244110091,"owners_count":20399562,"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":["collabland","proof-of-humanity","rarimo"],"created_at":"2024-11-24T04:11:48.489Z","updated_at":"2025-03-17T20:47:50.239Z","avatar_url":"https://github.com/rarimo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\u003ch1\u003e\u003cb\u003eRarimo Proof of Humanity Collab.Land Action\u003c/b\u003e\u003c/h1\u003e\u003c/div\u003e\n\nThis repo implements an [Collab.Land] action that adds `/rarimo-verify` command to your Discord server and\nallow members to verify their humanity using the [Rarimo Proof of Humanity] case.\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n  * [Pre-requisites](#pre-requisites)\n    + [Environment](#environment)\n    + [Tunnel Forwarding](#tunnel-forwarding)\n- [Configuration](#configuration)\n- [Setup](#setup)\n  * [Starting the server](#starting-the-server)\n- [Run with Docker](#run-with-docker)\n  * [Build](#build)\n  * [Run](#run)\n- [Installing the Collab.Land actions](#installing-the-collabland-actions)\n- [API Specifications](#api-specifications)\n- [Contributing](#contributing)\n- [Changelog](#changelog)\n- [License](#license)\n\n## Getting Started\n\n### Pre-requisites\n\n#### Environment\n\n- **[Node.JS \u003e= version 18]**\n- **[Docker]**\n\n#### Tunnel Forwarding\n\n- **[ngrok]**\n\n## Configuration\n\n- Set `APP_URL` to the URL of your application in the `.env` file. This URL will be used\n  to redirect users after they verify their humanity. By default, it should be `http://localhost:8000`\n  if you didn't change the port (check [Starting the server](#starting-the-server))\n- Set `POH_APP_URL` to the according url of the Rarimo Proof of Humanity application in\n  the `.env` file. By default, it should be `https://robotornot.mainnet-beta.rarimo.com` for the\n  `devnet` and `https://robotornot.rarimo.com` for the `mainnet`.\n- (Optional) In order to verify the webhook requests coming from the Collab.Land bot, please set\n  the `SKIP_VERIFICATION` variable in your `.env` file to `false`.\n- Please, fetch the public key from the [**[Collab.Land Config]**], and replace\n  `COLLABLAND_ED25519_PUBLIC_KEY_HEX` variables in the `.env` file.\n- (Optional) Set `LOG_LEVEL` to `debug` or `info` in the `.env` file to specify the log level. By default, it\n  will be `debug`.\n\nCheck the full `.env` file [example](./env-example) config for more details.\n\n## Setup\n\n### Starting the server\n\n- Clone the repository to your machine\n- Open the folder in a code editor of your choice\n- Install dependencies:\n  ```bash\n  yarn install\n  ```\n- Run Postgres in Docker:\n  ```bash\n  docker-compose up -d\n  ```\n- Start the server (The server starts in port `8000` by default):\n  ```bash\n  yarn dev\n  ```\n- If the server fails due to the port being occupied, change the server port in the [package.json]\n  file and in the `.env` file accordingly:\n  ```json\n  // file: package.json\n\n  {\n    \"scripts\": {\n      \"dev\": \"next dev -p \u003cPORT\u003e\"\n    }\n  }\n  ```\n  ```bash\n  # file: .env\n\n  APP_URL=\"http://localhost:\u003cPORT\u003e\"\n  ```\n- To expose your localhost API to public domain, open a new terminal and start NGROK:\n  ```bash\n  ngrok http \u003cPORT\u003e\n  ```\n- Copy the `.ngrok.io` link shown in your terminal:\n  ```bash\n  # Example:\n\n  https://0c49-2601-646-9e00-80-3964-47d-7146-ff13.ngrok.io/\n  ```\n\n## Run with Docker\n\n### Build\n\nTo build the Docker image, run the following command:\n\n```bash\ndocker build . -t rarimo-poh:latest\n```\n\n### Run\n\nRun the following command:\n\n```bash\ndocker-compose up -d\n```\n\nApplication will be available at `http://localhost:8000`, if you didn't change the port in the\n[package.json] file and in the `.env` file, otherwise, you have to change the port accordingly in\nthe `docker-compose.yml` file in the `ports` section:\n\n```yaml\n# file: docker-compose.yml\n\nservices:\n  rarimo-poh:\n    image: rarimo-poh:latest\n    restart: unless-stopped\n    entrypoint: sh -c \"node_modules/.bin/next start\"\n    ports:\n      - \"\u003cPORT\u003e:8000\"\n```\n\n## Installing the Collab.Land actions\n\n- Follow these steps to install the Collab.Land actions: [Test the Actions in a Discord server]\n- Verify your humanity with the `/rarimo-verify` command\n\n## API Specifications\n\n- The API exposes two routes per slash command:\n  - GET `/verify/metadata`: To provide the metadata for the `/rarimo-verify` command\n  - POST `/verify/interactions`: To handle the Discord interactions corresponding to the `/rarimo-verify`\n    command\n- The slash commands provide example codes for the following Discord interactions:\n  - `/rarimo-verify`: Verify your humanity with Rarimo Proof of Humanity use case and get the verified role\n    in your Discord server.\n\n## Contributing\n\nWe welcome contributions from the community! To contribute to this project, follow these steps:\n\n1. Please go through the following [\"build a custom action\"] article to understand the deep\n   technical details regarding building on the [Collab.Land] actions platform.\n1. Fork the repository.\n1. Create a new branch with a descriptive name for your feature or bug fix.\n1. Make your changes and commit them.\n1. Push your changes to your branch on your GitHub fork.\n1. Create a pull request from your branch to the `main` branch of this repository.\n\nPlease ensure your pull request adheres to the following guidelines:\n\n- Add a clear pull request title;\n- Add a comprehensive pull request description that includes the motivation behind the changes,\n  steps needed to test them, etc;\n- Update the CHANGELOG.md accordingly;\n- Keep the codebase clean and well-documented;\n- Make sure your code is properly tested;\n- Reference any related issues in your pull request;\n\nThe maintainers will review your pull request and may request changes or provide feedback before\nmerging. We appreciate your contributions!\n\n## Changelog\n\nFor the changelog, see [CHANGELOG.md](./CHANGELOG.md).\n\n## License\n\nThis project is under the MIT License — see the [LICENSE](./LICENSE) file for details.\n\n[Rarimo Proof of Humanity]: https://docs.rarimo.com/use-cases/proof-of-humanity\n\n[ngrok]: https://ngrok.com/docs/getting-started\n\n[Node.JS \u003e= version 18]: https://nodejs.org/en/download/\n\n[Docker]: https://docs.docker.com/engine/install/\n\n[Collab.Land]: https://www.collab.land/\n\n[Collab.Land Config]: https://api-qa.collab.land/config\n\n[\"build a custom action\"]: https://dev.collab.land/docs/upstream-integrations/collab-actions/getting-started-with-collab-actions\n\n[package.json]: ./package.json\n\n[Test the Actions in a Discord server]: https://dev.collab.land/docs/upstream-integrations/collab-actions/getting-started-with-collab-actions#test-the-actions-in-a-discord-server\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Fcollabland-rarimo-poh-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frarimo%2Fcollabland-rarimo-poh-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Fcollabland-rarimo-poh-action/lists"}