Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 2.42 KB

README.md

File metadata and controls

95 lines (63 loc) · 2.42 KB
Raw

Warning

The Restyled GitHub App is deprecated and will be disabled in the coming months. Please run Restyled using GitHub Actions . It works just as well or better, and is completely free, even for private repositories.

If you're interested in why we're making this change, see here.

restyled.io

Website and backend for Restyled, https://restyled.io.

Development & Testing

  1. Start persistence services:

    docker-compose up -d

  2. Initialize dependencies, the database, build, lint and test:

    just bootstrap

From here, you can use any stack-based development and testing work-flow.

Fully-functional Website

  1. Setup local secrets in .env

    cp .env.example .env.development
$EDITOR .env.development

  2. Run the site and backend locally:

    just watch

  3. Run ngrok:

    This is required for OAuth login and receiving webhooks from our development GitHub Application. You will need to get the ngrok authentication token out of band somehow.

    ngrok authtoken <YOUR_AUTHTOKEN>
ngrok http -subdomain restyled 3000

    Visit https://restyled.ngrok.io.

End-to-end Processing

To process real restyled-io/demo Pull Requests:

  1. Ensure a Restyler image is available to use:

    To use a locally-built image:

    (cd ../restyler && docker build --tag restyled/restyler .)

    To use a deployed image, set RESTYLER_IMAGE in .env.development.

    At this time, individual Restylers will always be pulled from deployed sources.

  2. Trigger a restyling:

    • Open a PR on restyled-io/demo,

    • Re-deliver an existing Webhook, or

    • Use curl, probably with files in fixtures/:

      curl \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data @"path/to.json" "https://restyled.ngrok.io/webhooks"

LICENSE

Restyled is source-available, Commons Claused licensed. For a detailed description of another project's rationale for this licensing model, one with which I agree, see here.

CHANGELOG | LICENSE