https://github.com/louisefindlay23/section-author-feed
Generating author feeds for Section's Engineering Education Blog.
https://github.com/louisefindlay23/section-author-feed
author blog feed json node-js
Last synced: about 1 year ago
JSON representation
Generating author feeds for Section's Engineering Education Blog.
- Host: GitHub
- URL: https://github.com/louisefindlay23/section-author-feed
- Owner: louisefindlay23
- Created: 2021-08-30T16:11:21.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-26T14:32:15.000Z (over 3 years ago)
- Last Synced: 2025-04-12T07:59:15.651Z (about 1 year ago)
- Topics: author, blog, feed, json, node-js
- Language: JavaScript
- Homepage: https://section-author-feeds.louisefindlay.com
- Size: 342 MB
- Stars: 5
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚 Table of Contents
- [👁 Overview](#-overview)
- [🎯 Features](#-features)
- [⚙ Usage](#-usage)
- [👀 Demo](#-demo)
- [💡 Why I Built Section Author Feed](#-why-i-built-section-author-feed)
- [💻 Technologies](#-technologies)
- [Server Technologies](#server-technologies)
- [Action Technologies](#action-technologies)
# 👁 Overview
Looking to generate an author feed for your Section.io Engineering Education articles to showcase your amazing technical articles? Use the Node.js web app to create your unique author feed URL and embed in your GitHub Profile Readme using the GitHub Action.
# 🎯 Features
- **Web App** - Looking for an easy way to create your own author feed? Use the [web app](https://section-author-feeds.louisefindlay.com/) and enter your name to discover your URL and JSON file containing all the articles you've written.
- **API** - Desire programmability and prefer the command line? Just call the API: `https://section-author-feeds.louisefindlay.com/feed/author/[author-name]`. It will update every time an article has been published on the EngEd website.
- **GitHub Action** - Use the [GitHub Action](https://github.com/louisefindlay23/section-author-feed/blob/master/.github/workflows/fetchjson.yml) to embed the feed in your GitHub Readme. Updates hourly.
# ⚙ Usage
- Head to the [website](https://section-author-feeds.louisefindlay.com) and enter your name (used in your Section Author Profile) to generate your feed.
- You can use that unique URL, `https://section-author-feeds.louisefindlay.com/feed/author/[author-name]` wherever you want to retrieve the JSON feed.
- To embed in your GitHub Profile Readme, copy the [GitHub Action file](https://github.com/louisefindlay23/section-author-feed/blob/docs/.github/workflows/fetchjson.yml) to `.github/workflows/fetchjson.yml` and insert `` and `` to your Readme where you would like the data to be added.
# 💡 Why I Built Section Author Feed
I built Section Author Feed so I could embed a list of articles I'd written for the EngEd blog on my GitHub Profile Readme to showcase my technical writing. Currently, the RSS feed available can't be filtered by author and I wanted the control of using JSON in being able to format and style the article list in my readme more flexibly. Thus Section Author Feed was born.
# 💻 Technologies
See below for the range of technologies used to build both the web app and GitHub Action.
## Server Technologies
- **[Node.js](https://nodejs.org/en/)** - Server-side JavaScript
- **[DigitalOcean](https://www.digitalocean.com/)** - Cloud hosting for the Node.js server
- **[Express](https://expressjs.com)** - Web Server for the Web App
- **[Axios](https://axios-http.com/)** - To fetch existing Section RSS Feed
- **[FS](https://nodejs.dev/learn/the-nodejs-fs-module)** - To save JSON file created on the server
- **[XML2JS](https://github.com/Leonidas-from-XIV/node-xml2js)** - To parse and convert the XML RSS feed to JSON for easier manipulation
## Action Technologies
Here is the list of GitHub Actions I adapted in order to create Fetch JSON to call the API and embed the following data in a Readme.
- **[Upload Artifact](https://github.com/actions/upload-artifact)** - Uploads the JSON File which has been fetched from the API as an artifact
- **[JSON2Table](https://github.com/EddieHubCommunity/gh-actions-html-table-generator)** - Reads the JSON file, parses it and then formats the data into a HTML table which can be embedded into a GitHub readme using tags.
# 👀 Demo
