trelllis/syndication-service repository overview

⁠Syndication Service

Translates the given HTML into service-specific HTML formats for native syndication.

⁠Installation

⁠Manual

⁠Requirements

• Node.js

⁠Install & Run

• Clone this repo
• cd to the root of the project and run npm install
• Run the server using npm start. (default port for the app is 5000)

⁠Docker

⁠Requirements

• Docker

⁠Install & Run

To install and run using docker:

• Create an image with docker build -t trellis/syndication-service
• Run the server with docker run -d -p 5000:5000 trellis/syndication-service

⁠Usage

⁠Services

⁠Facebook Instant Article

⁠Request

Make http request to {domain}/instant with najem api article details response as a body param (all the response object).

body param example (not all the response value are present in the example):

{
  id: "b7f998fa-2b68-45dc-b336-7d462dba402d",
  url: "http://dev.najem.com/articles/adelllleee-5696d13adfa25",
  short_url: "http://njm.fm/2015jNJ",
  title: "adelllleee",
  description: "",
  slug: "adelllleee-5696d13adfa25",
  is_promoted: true,
  promotion_position: 1,
  is_trending: false,
  is_evergreen: false,
  content: {} //object containning the html, embeds, links, images, quotes and styles
}

⁠Response

Service will return JSON object with html key with the content formated for facebook instant articles.

{
  html: string
}