https://github.com/plebbit/plebbit-previewer
https://github.com/plebbit/plebbit-previewer
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/plebbit/plebbit-previewer
- Owner: plebbit
- License: gpl-2.0
- Created: 2023-04-08T20:53:38.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-18T19:22:40.000Z (over 1 year ago)
- Last Synced: 2025-02-18T20:29:52.781Z (over 1 year ago)
- Language: JavaScript
- Size: 213 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Demo
The plebbit-previewer allows users to share links on sites like Twitter, Telegram, etc. and generate a preview. E.g. the URL https://plebbitapp.eth.limo/#/p/reddit-screenshots.eth/c/QmbJuRPxPhncxkiGLEcCaFvawoGuoZdrwp26aPNzkSUYHa becomes https://pleb.bz/p/reddit-screenshots.eth/c/QmbJuRPxPhncxkiGLEcCaFvawoGuoZdrwp26aPNzkSUYHa which will generate a preview and redirect the user to the app.
### Params
- /c/:commentCid
- /p/:subplebbitAddress/c/:commentCid
- /:commentCid
- /p/:subplebbitAddress/c/:commentCid?redirect=plebchan.eth.limo
### How to use
```
npm install
npm run start
```
### How to use with docker
```
npm install
scripts/start-docker.sh
```
### config.js
A javascript file like:
```
module.exports = {
port: 3924,
plebbitOptions: {
ipfsGatewayUrls: ['https://ipfs.io'],
},
// whitelisted sites that are allowed to redirect
// the first site is the default
redirects: [
'plebbitapp.eth.limo'
]
}
```