{"id":26930352,"url":"https://github.com/zkitter/zkitterd","last_synced_at":"2025-07-25T08:09:58.850Z","repository":{"id":42537333,"uuid":"392663004","full_name":"zkitter/zkitterd","owner":"zkitter","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-19T10:50:43.000Z","size":21340,"stargazers_count":10,"open_issues_count":11,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T18:09:02.997Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/zkitter.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}},"created_at":"2021-08-04T11:29:39.000Z","updated_at":"2023-04-03T08:55:28.000Z","dependencies_parsed_at":"2023-02-06T07:32:11.759Z","dependency_job_id":null,"html_url":"https://github.com/zkitter/zkitterd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zkitter/zkitterd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitterd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitterd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitterd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitterd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zkitter","download_url":"https://codeload.github.com/zkitter/zkitterd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitterd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266978008,"owners_count":24015487,"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-07-25T02:00:09.625Z","response_time":70,"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":[],"created_at":"2025-04-02T06:19:05.151Z","updated_at":"2025-07-25T08:09:58.807Z","avatar_url":"https://github.com/zkitter.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zkitterd\n\n[![Build](https://github.com/zkitter/zkitterd/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/zkitter/zkitterd/actions/workflows/build-and-test.yml)\n[![Discord](https://img.shields.io/discord/887573677959417889)](https://discord.com/invite/GVP9MghwXc)\n\nOfficial Node/Typescript implementation of the [Zkitter](https://docs.zkitter.com/) full node.\n\n## Requirements\n\n- Node 12.22+\n- NPM 6.14+\n- PostgresSQL 13\n\n### Configurations\n\nYou can set configuration using environment variable or by creating a `config.prod.json` or `config.dev.json` file. You can see a sample of the config file [here](./config.sample.json).\n\n| Name                   | Description                                                                                                                                  |\n| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `WEB3_HTTP_PROVIDER`   | a valid Http provider (e.g. `https://mainnet.infura.io/v3/\u003cproject-id\u003e`)                                                                     |\n| `ENS_RESOLVER`         | contract address for ENS Public Resolver                                                                                                     |\n| `DB_DIALECT`           | The dialect of the database you are connecting to. One of mysql, postgres, sqlite and mssql.                                                 |\n| `DB_STORAGE`           | Only used by sqlite. Defaults to `:memory:`                                                                                                  |\n| `DB_NAME`              | The name of the database                                                                                                                     |\n| `DB_USERNAME`          | The username which is used to authenticate against the database.                                                                             |\n| `DB_PASSWORD`          | The password which is used to authenticate against the database.                                                                             |\n| `DB_HOST`              | The host of the relational database.                                                                                                         |\n| `DB_PORT`              | The port of the relational database.                                                                                                         |\n| `PORT`                 | The port of the REST API server. Defaults to `3000`                                                                                          |\n| `GUN_PORT`             | The port of the GUN relay peer. Defaults to `8765`                                                                                           |\n| `GUN_PEERS`            | Seed peers to connect to for GunDB.                                                                                                          |\n| `RAPIDAPI_KEY`         | API Key from [Rapid API](https://rapidapi.com/hub). This is for calculating reputation score on twitter account.                             |\n| `TW_CALLBACK_URL`      | Callback API for twitter oauth 1.0a Defaults to `http://127.0.0.1:3000/twitter/callback`.                                                    |\n| `TW_CONSUMER_KEY`      | Twitter API Consumer Key.                                                                                                                    |\n| `TW_CONSUMER_SECRET`   | Twitter API Consumer Secret.                                                                                                                 |\n| `TW_BEARER_TOKEN`      | Twitter API Bearer Token.                                                                                                                    |\n| `TW_ACCESS_KEY`        | Twitter API Access Token.                                                                                                                    |\n| `TW_ACCESS_SECRET`     | Twitter API Access Secret.                                                                                                                   |\n| `ARB_HTTP_PROVIDER`    | a valid Http provider to Arbitrum network (e.g. `https://arbitrum.infura.io/v3/\u003cproject-id\u003e`).                                               |\n| `ARB_REGISTRAR`        | Contract address for the [registration contract](https://github.com/zkitter/contracts).                                                      |\n| `ARB_PRIVATE_KEY`      | Private Key to the Arbitrum address to be used to fund onboarding.                                                                           |\n| `ARB_ADDRESS`          | The Arbitrum address to be used to fund onboarding.                                                                                          |\n| `MODERATORS`           | Global moderations for the server. Defaults to `0x3F425586D68616A113C29c303766DAD444167EE8` and `0xd44a82dD160217d46D754a03C8f841edF06EBE3c` |\n| `WEB3_STORAGE_API_KEY` | [Web3 Storage ](https://web3.storage/) API Token                                                                                             |\n\n## Build Instructions\n\n**Installation**\n\n```\nnpm i\n```\n\n**Unit test**\n\n```\nnpm t\n```\n\n**Developement Build**\n\n```\nnpm run build-server\n```\n\n**Production Build**\n\n```\nnpm run build\n```\n\n**Run in development**\n\n```\nnpm run dev\n```\n\n**Run in production**\n\n```\nnpm start\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkitter%2Fzkitterd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzkitter%2Fzkitterd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkitter%2Fzkitterd/lists"}