/dropbox-mdwebhook-ts

A sample app that uses webhooks to convert Markdown files to HTML, built with Typescript.

Primary LanguageTypeScript

Markdown Webhook with Typescript

This simple example app uses webhooks to get notified of new Markdown files in Dropbox. It then converts all Markdown files it sees to HTML.

This example is a Node.js and Typescript clone of the Markdown Webhook project which is built with Flask by the Dropbox team. The only missing part is the Redis implementation because Heroku failed to verify my account with my credit card for some reason.

Read more about webhooks and this example on the Dropbox developers site.

You can try the example yourself by visiting dropbox-webhook-ts.herokuapp.com.

Running the sample yourself

This sample was built with Heroku in mind as a target:

  1. Copy .env_sample to .env and fill in the values.
  2. Run yarn install to install the necessary modules.
  3. Launch the app via yarn dev or deploy to Heroku.

Deploy on Heroku

Deploy

You can deploy directly to Heroku with the button below. First you'll need to create an API app via the App Console. Make sure your app has access to files (not just datastores), and answer "Yes - My app only needs access to files it creates" to ensure your app gets created with "App folder" permissions.

Deploy

Once you've deployed, you can easily clone the app and make modifications:

$ heroku clone -a new-app-name
...
$ vim index.js
$ git add .
$ git commit -m "update index.js"
$ git push heroku master
...