{"id":17788814,"url":"https://github.com/statebait/poketwitbot","last_synced_at":"2025-06-25T14:33:27.006Z","repository":{"id":43366209,"uuid":"168159842","full_name":"statebait/poketwitbot","owner":"statebait","description":"A simple Twitter bot that tweets about a random pokemon everyday.","archived":false,"fork":false,"pushed_at":"2022-12-09T06:39:48.000Z","size":113,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-02T00:44:05.526Z","etag":null,"topics":["api","axios","cheerio","cron","lodash","nodejs","pokemon","serverless","twit","twitter-bot"],"latest_commit_sha":null,"homepage":"https://twitter.com/PokeTwitBot1","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/statebait.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":"2019-01-29T13:32:52.000Z","updated_at":"2023-12-05T06:59:00.000Z","dependencies_parsed_at":"2023-01-25T11:45:30.608Z","dependency_job_id":null,"html_url":"https://github.com/statebait/poketwitbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/statebait/poketwitbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statebait%2Fpoketwitbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statebait%2Fpoketwitbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statebait%2Fpoketwitbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statebait%2Fpoketwitbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/statebait","download_url":"https://codeload.github.com/statebait/poketwitbot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statebait%2Fpoketwitbot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261892029,"owners_count":23225842,"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":["api","axios","cheerio","cron","lodash","nodejs","pokemon","serverless","twit","twitter-bot"],"created_at":"2024-10-27T10:23:48.811Z","updated_at":"2025-06-25T14:33:26.982Z","avatar_url":"https://github.com/statebait.png","language":"JavaScript","readme":"# PokeTwitBot - A twitter bot\r\n\r\n## Description\r\n\r\nA Simple Twitter Bot built using the [twit](https://github.com/ttezel/twit) Twitter API Client and the [PokeAPI](https://pokeapi.co/) (and a little bit of web scraping from https://www.pokemon.com). The bot will tweet about a pokemon.\r\n\r\n## Installation \u0026 Usage\r\n\r\n\u003e The `api` folder in this repo is for the serverless API setup using [Zeit(Vercel)](https://vercel.com/). It uses an [Airtable](https://airtable.com/invite/r/GPY1lsA0) config for storing which pokemons have been tweeted and uses a cron job service like [EasyCron](https://www.easycron.com/?ref=167187) to hit this API everyday.\r\n\r\n**1. Ensure that Node.js and yarn have been installed**\r\n\r\n- [Node](https://nodejs.org/)\r\n- [Yarn](https://yarnpkg.com/)\r\n\r\n**2. Clone the repo**\r\n\r\n```bash\r\ngit clone https://github.com/statebait/poketwitbot.git\r\n```\r\n\r\n**3. Install Dependencies**\r\n\r\n```bash\r\ncd poketwitbot # Go to the project root directory\r\nyarn\r\n```\r\n\r\n**4. Create the Environment File**\r\n\r\nIn the project root directory create a file called `.env` which contains your twitter app's access keys and tokens. The file should look like this:\r\n\r\n```bash\r\nTWITTER_USERNAME=\r\nTWITTER_CONSUMER_KEY=\r\nTWITTER_CONSUMER_SECRET=\r\nTWITTER_ACCESS_TOKEN=\r\nTWITTER_ACCESS_TOKEN_SECRET=\r\n```\r\n\r\n**5. Run the bot**\r\n\r\nTo run the bot you will need to import/require the bot.js file in your script, function or whatsoever like this:\r\n\r\n```js\r\nconst bot = require(\"./path/to/bot.js\");\r\n\r\nasync function main() {\r\n  const { success, error, message } = await bot(250); // Pass in any pokemon id as the argument (pokemon id is the pokemon no. in the pokedex\r\n  if (err) {\r\n    console.error(message);\r\n  } else if (success) {\r\n    console.log(message);\r\n  }\r\n}\r\n```\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - Copyright (c) 2020 Mohamed Shadab\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstatebait%2Fpoketwitbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstatebait%2Fpoketwitbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstatebait%2Fpoketwitbot/lists"}