Coder Social home page Coder Social logo

joshua2504 / skyhook Goto Github PK

View Code? Open in Web Editor NEW

This project forked from commit451/skyhook

0.0 0.0 0.0 1.27 MB

Parses webhooks and forwards them in the proper format to Discord.

Home Page: https://commit451.github.io/skyhook-web

License: MIT License

TypeScript 99.77% Dockerfile 0.23%

skyhook's Introduction

skyhook

Parses webhooks and forwards them in the proper format to Discord.

Discord

Setup

You can use the site to create the right webhook link. If you want to manually do it, here are the steps:

  1. Create a webhook in Discord (Server Settings -> Webhooks -> Create Webhook)
  2. Copy the webhook url
  3. Turn the Discord webhook url into a skyhook webhook url like so:
Replace discord.com in url with skyhookapi.com
https://discord.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook
->
https://skyhookapi.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook
  1. Add the provider you want to the end of the url:
https://skyhookapi.com/api/webhooks/firstPartOfWebhook/secondPartOfWebhook/providerGoesHere

Supported Providers

If you want support for a new provider, just create a pull request and add it!
Alternatively, a new provider can also be requested by creating an issue.

Contributing

If you wish to contribute, follow our contributing guide.

Creating a Provider

If you want to create a new provider please follow the examples shown at our small documentation.

Testing Locally

To build:

npm run build

To run server (after building):

npm start

To do both:

npm run buildstart

To run tests:

npm test

Through Docker:

docker run -it --rm -p 8080:8080 commit451/skyhook

Web

If you are looking for the frontend web version of skyhook which lets you generate a properly formatted URL, it lives here. This repo/project just includes the backend service.

Deploying

Thanks

Special thanks to all our amazing contributors. skyhookapi.com is hosted for free for you, so if you feel so inclined, buy a coffee!

License

skyhook is available under the MIT license. See the LICENSE file for more info.

\ ゜o゜)ノ

skyhook's People

Contributors

jawnnypoo avatar dscalzi avatar akizo96 avatar neuxz avatar dependabot[bot] avatar favna avatar lugghawk avatar baconcheese113 avatar tiagodanin avatar wh1337 avatar munsio avatar mands avatar sg004 avatar nbyavuz avatar skmedix avatar thephd avatar logerfo avatar kobkrit avatar jameds avatar justalemon avatar felipepaiva1992 avatar miralita avatar betterb0y avatar blowaxd avatar dahlgren avatar alexwh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.