Website and backend for Restyled, https://restyled.io.
-
Start persistence services:
docker-compose up -d
-
Create and seed the database, install dependencies:
make db.create db.migrate db.seed setup setup.lint setup.tools
-
Build, test, and lint the application:
make
From here, you can use any
stack
-based development and testing work-flow.
-
Setup local secrets in
.env
cp .env.example .env.development $EDITOR .env.development
-
Run the site and backend locally:
make watch
-
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
.
To process real restyled-io/demo
Pull Requests:
-
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
andRESTYLER_TAG
in.env.development
.At this time, individual Restylers will always be pulled from deployed sources.
-
Trigger a restyling:
- Open a PR on
restyled-io/demo
, - Re-deliver an existing Webhook, or
- Use
bin/curl-webhook
with files underfixtures/
- Open a PR on
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.