Skip to content

mtdev2/restyled.io

 
 

Repository files navigation

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:

    make 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:

    make 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 and RESTYLER_TAG 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 | CONTRIBUTING

Packages

No packages published

Languages

  • Haskell 84.5%
  • CSS 11.3%
  • Shell 1.9%
  • JavaScript 0.8%
  • Makefile 0.8%
  • Dockerfile 0.5%
  • Other 0.2%