https://github.com/overflowcat/instant-overview

Generate telegra.ph pages from webpage
https://github.com/overflowcat/instant-overview

Last synced: 10 months ago
JSON representation

Generate telegra.ph pages from webpage

• Host: GitHub
• URL: https://github.com/overflowcat/instant-overview
• Owner: OverflowCat
• Created: 2021-12-05T07:01:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-20T11:20:26.000Z (over 4 years ago)
• Last Synced: 2025-07-05T22:11:56.924Z (11 months ago)
• Language: TypeScript
• Homepage: https://github.com/Kenshin/simpread/discussions/3337
• Size: 255 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.textile

Awesome Lists containing this project

README

          
h1. instant-overview

h2. Description

@instant-overview@ is an ᴀᴘɪ backend made for "SimpRead":http://ksria.com/simpread/ the browser extension ("Kenshin/simpread":https://github.com/Kenshin/simpread), which lets you generate "Telegraph":https://telegra.ph/ archives from reader-mode pages of Simpread with ease.

h2. Usage

**We will host an official instance on Vercel at [to be implemented], but it is a click away to host your own one.** Currently we do not store any data. Changes may be made in the future.

h2. Development and deployment

Bug fixes and contribution are welcome. Part of the code will be share in the "Save to Telegraph" plugin in SimpRead to optimize the logic for crawling key parts of webpages.

h3. Setting up the environment

* Clone this repository

bc(. git clone https://github.com/OverflowCat/instant-overview.git --depth=1

cd instant-overview

* Install @nodejs@ and @npm@

bc(. sudo apt update

sudo apt install nodejs npm

* Install dependencies

bc(. npm install

npm install -g typescript nodemon concurrently

* Develop and debug

bc(. npm run dev

* Compile to JavaScript

bc(. tsc

* Compile to a single file

bc(. ncc build src/exec.ts -o single/instant-overview.js -m

* Run the program

bc(. node src/index.js

h3. Functionality

The server will respond to ᴘᴏsᴛ requests at @[IP]:7784/publish@. Sample request and response have been written in "@src/index.ts@":https://github.com/OverflowCat/instant-overview/blob/master/src/index.ts.