{"id":13712021,"url":"https://github.com/Olanetsoft/web3terms","last_synced_at":"2025-05-06T21:32:58.487Z","repository":{"id":42049975,"uuid":"477333130","full_name":"Olanetsoft/web3terms","owner":"Olanetsoft","description":"A bot explaining and simplifying web3 terms to everyone","archived":false,"fork":false,"pushed_at":"2023-09-24T15:54:31.000Z","size":559,"stargazers_count":96,"open_issues_count":2,"forks_count":52,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2024-08-03T23:24:01.081Z","etag":null,"topics":["blockchain","ethereum","hacktoberfest","javascript","nodejs","opensource","resources","twitter","twitter-api","twitter-bot"],"latest_commit_sha":null,"homepage":"https://twitter.com/web3terms","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/Olanetsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-03T12:21:13.000Z","updated_at":"2024-07-09T18:20:21.000Z","dependencies_parsed_at":"2023-02-12T12:55:14.485Z","dependency_job_id":null,"html_url":"https://github.com/Olanetsoft/web3terms","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/Olanetsoft%2Fweb3terms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Olanetsoft%2Fweb3terms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Olanetsoft%2Fweb3terms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Olanetsoft%2Fweb3terms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Olanetsoft","download_url":"https://codeload.github.com/Olanetsoft/web3terms/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224535697,"owners_count":17327575,"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":["blockchain","ethereum","hacktoberfest","javascript","nodejs","opensource","resources","twitter","twitter-api","twitter-bot"],"created_at":"2024-08-02T23:01:14.122Z","updated_at":"2024-11-13T22:31:08.798Z","avatar_url":"https://github.com/Olanetsoft.png","language":"JavaScript","funding_links":[],"categories":["GitHub Repositories"],"sub_categories":[],"readme":"# web3terms\n\n[![GitHub issues](https://img.shields.io/github/issues/Olanetsoft/web3terms?style=plastic)](https://github.com/Olanetsoft/web3terms/issues)\n[![GitHub forks](https://img.shields.io/github/forks/Olanetsoft/web3terms?style=plastic)](https://img.shields.io/github/forks/Olanetsoft/web3terms)\n[![GitHub stars](https://img.shields.io/github/stars/Olanetsoft/web3terms?style=plastic)](https://img.shields.io/github/stars/Olanetsoft/web3terms)\n[![GitHub watchers](https://img.shields.io/github/watchers/Olanetsoft/web3terms?style=plastic\u0026label=Watch)](https://github.com/Olanetsoft/web3terms)\n[![Twitter Follow](https://img.shields.io/twitter/follow/web3terms.svg?style=social)](https://twitter.com/web3terms) \n\n\nA Twitter bot explaining and simplifying web3 terms to everyone!\n\n\u003cimg width=\"600\" alt=\"Screenshot 2022-04-07 at 22 58 40\" src=\"https://user-images.githubusercontent.com/45847909/162620196-98c4c249-de0b-42de-bb8e-bdb19062d64e.png\"\u003e\n\n## 🏆 Features\n\n+ Web3 terms explanation ✅\n+ Daily Web3 terms tweet ✅\n+ Acknowledgement tweet ✅\n+ Test Coverage ✅\n+ Endpoint `https://web3terms.onrender.com/terms` to retrieve all terms ✅\n    + Response:\n    ```json\n        {\n            \"previousPage\": \"xx\",\n            \"nextPage\": \"xx\",\n            \"total\": xxx,\n            \"totalPages\": xxx,\n            \"items\": [\n                {\n                    \"term\": \"abi\",\n                    \"meaning\": \"ABI is the standard way to interact with contracts in the Ethereum ecosystem, both from outside the blockchain and for contract-to-contract interaction.\"\n                },\n                \n                //...\n            ]\n        }\n   ```\n   + To filter, pass the query params `page` and/or `limit`.\n   \n## 🛠 Installation\n\n+ Install [Node.js](http://nodejs.org/) on your PC\n+ Start by making a fork of the repository. Click on the \"Fork\" symbol at the top right corner\n+ Clone this repo\n```bash\ngit clone https://github.com/Olanetsoft/web3terms.git\n```\n+ Run \n```bash\nyarn\n```\n\n\u003e It will install [Twit](https://github.com/ttezel/twit), the library that lets us talk to Twitter.\n\n\n## 🥂 After making a change\n1. Sort the file\n```\nyarn run sort\n```\n\n2. Run a test to check all definition length\n```\nyarn test\n```\n\n3. Create a new branch\n```bash\ngit checkout -b \u003cYour-branch-name\u003e\n```\n\n4. Add changes \n```bash\ngit add .\n```\n\n5. Add a commit message\n```bash\ngit commit -m \"\u003cyour message\u003e\"\n```\n\n6. Push your changes\n```bash\ngit push --set-upstream origin \u003cbranch-name\u003e\n```\n\n7. Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)\n\n8. Congratulations 🙌🏼\n\n\n## 🔀 Connecting to Twitter\n\n1. Register a Twitter account and also get its \"app info\".\n\u003eTwitter doesn't allow you to register multiple twitter accounts on the same email address. I recommend you create a brand new email address (perhaps using Gmail) for the Twitter account. Once you register the account to that email address, wait for the confirmation email.\n\n2. Now go [here](https://dev.twitter.com/apps/new) and log in as the Twitter account for your bot:\n3. Fill up the form and submit.\n4. Next once the submission completes you will be taken to a page which has the \n+ \"Settings\" tab : Update details here\n+ \"Permissons\" tab :  Enable `Read and Write` \n+ \"Key and Access Token\" tab : Click on `Generate access token`. \n5. Create a `.env` file and fill in the generated tokens in the \"Key and Access Token\" tab.\n\nIt should look like this:\n```sh\nPORT=xxxx\nNODE_ENV=development\n\nDEV_BASE_URL=http://localhost:$PORT\nPROD_BASE_URL=http://localhost:$PORT\n\nTWITTER_CONSUMER_KEY=xxxx\nTWITTER_CONSUMER_SECRET=xxxx\n\nTWITTER_ACCESS_TOKEN=xxxx\nTWITTER_ACCESS_TOKEN_SECRET=xxxx\n```\n6. Type the following in the command line in your project directory to start the project\n\n```bash\nyarn dev\n```\n\nYou should have something similar to what is shown below on your terminal.\n\n```javascript\n[LOGGING] info: \"Connected!\"\n[LOGGING] info: \"Server running on port xxxx\"\n```\n\n## 👨‍👩‍👦 Community\nDon't forget to follow [Web3terms](https://twitter.com/web3terms) on twitter\n\n\n### 🧑‍💻 Contributing\n\n- Contributions make the open source community such an amazing place to learn, inspire, and create.\n- Any contributions you make are greatly appreciated.\n- Check out our contribution guidelines for more information.\n\n+ **Star** - If you like it\n+ **Fork** - If you like to build your own version\n+ **File an issue** - If you found a bug\n+ **Send a pull request** - If you want to contribute\n\n\n### **Whats Next**\n\nYou might want to push this app to a running server, [here is a curated list you can checkout.](https://www.heroku.com/).\n\n\u003e Do not misuse the twitter api to spam or burden the server load for twitter api, as twitter follows a strict rule of closing down accounts that do that. Please read [here for the rules](https://support.twitter.com/articles/18311)\n\n### **Note to Contributors**\n\n+ All web3 terms in the ```data/terms.json``` directory should be in lowercase.\n+ Look to ensure that newly added terms aren't already available to avoid repetition of terms and keywords.\n\n\n### 🫂 Credits\n\n- [Twit Library](https://github.com/ttezel/twit)\n- [Nishant Srivastava](https://github.com/nisrulz)\n- [Ugwu Stanley](https://github.com/ugwustanley) the creator of [Decode Abbreviation](https://twitter.com/decode_abbr)\n\n\n### Thanks to all Contributors 💪 \n\nThanks a lot for spending your time helping Web3Terms Bot grow. Happy Hacking 🍻\n\n[![Contributors](https://contrib.rocks/image?repo=Olanetsoft/web3terms)](https://github.com/Olanetsoft/web3terms/edit/develop/README.md)\n\n### Thanks to all Stargazers ⭐️\n\n[![Thanks to all stargazers](https://git-lister.onrender.com/api/stars/Olanetsoft/web3terms?limit=15)](https://github.com/Olanetsoft/web3terms)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOlanetsoft%2Fweb3terms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOlanetsoft%2Fweb3terms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOlanetsoft%2Fweb3terms/lists"}