Thanks to visit codestin.com
Credit goes to github.com

Skip to content

justbustin/previewer

 
 

Repository files navigation

previewer

🎵 Welcome to Previewer 🎵

Advanced Link Previews in Discord!

⚙️ Installation

Public Bot

Heroku

Deploy

  1. Click the Deploy to Heroku button above
  2. Enter your discord bot's token as prompted
  3. Click Deploy app, then wait until it's finished
  4. Click Manage App
  5. Click Configure Dynos in the Dyno formation section
  6. Click the ✏️ icon on both dynos
  7. Disable the web dyno
  8. Enable the worker dyno
  9. Click confirm on both dynos
  10. Enjoy :)

Manual

Previewer requires Node.js to run.

Install the dependencies.

yarn install

Create and configure an .env file from the following template:

# Your discord bot's token
DISCORD_BOT_TOKEN=
# Your opensea api key, only required for parsing collections
OPENSEA_API_KEY=

Start it!

# Start in development
yarn dev

# OR

# Watch in development
yarn watch

# OR

# Start in production
yarn build
yarn start

✅ Supported Websites

https://www.tiktok.com/@vscode/video/6932506933505166598
https://opensea.io/collection/boredapeyachtclub
$TICKER
  • ... More Soon (Requests are welcome and encouraged)

🕹️ Usage

  1. Invite the bot

  2. Make sure the bot has the following permissions in the channels you want it to work in:

    • View Channel
    • Send Messages
    • Embed Links
    • Attach Files
    • Read Message History
  3. Send a link matching one of the supported websites

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

Distributed under the MIT License. See LICENSE for more information.

About

Advanced Link Previews In Discord

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.7%
  • Shell 0.3%