Skip to content

README.md

Latest commit

 

History

History
51 lines (30 loc) · 1.24 KB

README.md

File metadata and controls

51 lines (30 loc) · 1.24 KB
Raw

random-mdn-bot

A bot that posts random MDN articles

Static Badge

The project uses GitHub Actions to run a Node.js script every eight hours.

The script reads out the MDN sitemap, parses it and posts the found article to Bluesky.

Setup

# clone the repo and get the source code
git clone git@github.com:random-mdn/random-mdn-bot.git

# install dependencies
npm install

# setup env
cp .env.example .env

Local development

To execute the script locally run npm run dev in the project's directory.

It should look as follows:

npm run dev

CLI options

Dry run

Run the function without posting the article.

npm run dev -- --dry-run

Roadmap

If you would like to help ❤️ that would be awesome! You can find ideas and the current planning in the planning issue.

Code of conduct

This project follows and enforece a Code of Conduct to make everybody feel welcomed and safe.