Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LibrariesHacked/library-alt-text-bot
A twitter bot to promote web accessibility for libraries on Twitter
https://github.com/LibrariesHacked/library-alt-text-bot
accessibility bot html nodejs tweets twitter twitter-api twitter-bot web-accessibility
Last synced: 4 months ago
JSON representation
A twitter bot to promote web accessibility for libraries on Twitter
- Host: GitHub
- URL: https://github.com/LibrariesHacked/library-alt-text-bot
- Owner: LibrariesHacked
- License: mit
- Created: 2022-04-25T18:18:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-08T20:38:00.000Z (over 1 year ago)
- Last Synced: 2024-07-30T21:02:04.367Z (6 months ago)
- Topics: accessibility, bot, html, nodejs, tweets, twitter, twitter-api, twitter-bot, web-accessibility
- Language: JavaScript
- Homepage: https://twitter.com/LibraryAltText
- Size: 2.23 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Library alt text bot
This bot finds tweets from library accounts that include images without alt text. It quote tweets these with useful guidance on creating accessible social media.
## Getting Started
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.
### Prerequisites
The project uses NodeJS and the [Twitter API](https://developer.twitter.com/en/docs/tweets/tweet-updates) which requires a [Twitter API key](https://developer.twitter.com/en/apps).
- [Node JS](https://nodejs.org)
### Installing
Assuming you have Node.js installed, you can install the project dependencies by running:
```console
npm install
```
### Running the Bot
For the bot to work it requires Twitter API keys for an account with permission to use the Twitter API. You can get these keys from your Twitter developer account.
Rename the `.env.sample` file to `.env` and add your Twitter API keys.
The bot can then be run using the following command:
```console
node app.js
```
## Deployment
The bot is deployed by using GitHub Actions. The bot is configured to run on a 15 minute schedule and push the latest tweet processed to this reository in the [counter](counter) file.
```yaml
# Runs every 30 minutes during the day
schedule:
- cron: '*/30 6-20 * * *'
```
## Authors
- **Libraries Hacked** - *Repository setup and coding* - [DaveBathnes](https://github.com/DaveBathnes)
See also the list of [contributors](https://github.com/LibrariesHacked/library-alt-text-bot/contributors) who participated in this project.
## License
This project is licensed under the [MIT](LICENSE) license.
## Acknowledgments
- [Library Cactus](https://twitter.com/SarahHLib) who maintains Twitter lists of library accounts.
- [Matt Eason](https://twitter.com/matteason) who created the [UKGovAltBot](https://twitter.com/UKGovAltBot) and other alt bot accounts.