Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/restyled-io/restyled.io
Restyled.io
https://github.com/restyled-io/restyled.io
Last synced: 3 days ago
JSON representation
Restyled.io
- Host: GitHub
- URL: https://github.com/restyled-io/restyled.io
- Owner: restyled-io
- License: other
- Created: 2017-08-28T19:53:39.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T13:58:51.000Z (about 1 month ago)
- Last Synced: 2024-11-06T04:25:15.126Z (10 days ago)
- Language: Haskell
- Homepage:
- Size: 3.54 MB
- Stars: 157
- Watchers: 8
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> The Restyled GitHub App is deprecated and will be disabled in the coming months. Please [run Restyled using GitHub Actions](https://github.com/restyled-io/actions#readme) . 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](https://docs.restyled.io/news/github-actions-pivot/).
# restyled.io
Website and backend for Restyled, https://restyled.io.
## Development & Testing
1. Start persistence services:
```console
docker-compose up -d
```
1. Initialize dependencies, the database, build, lint and test:
```console
just bootstrap
```
From here, you can use any `stack`-based development and testing work-flow.
## Fully-functional Website
1. Setup local secrets in `.env`
```console
cp .env.example .env.development
$EDITOR .env.development
```
1. Run the site and backend locally:
```console
just watch
```
1. 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._
```console
ngrok 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:
```console
(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._
1. Trigger a restyling:
- Open a PR on `restyled-io/demo`,
- Re-deliver an existing Webhook, or
- Use `curl`, probably with files in `fixtures/`:
```console
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][cc] licensed. For a detailed
description of another project's rationale for this licensing model, one with
which I agree, see [here][level].
[cc]: https://commonsclause.com/
[level]: https://web.archive.org/web/20181120030157/https://leveljournal.com/source-available-licensing
---
[CHANGELOG](./CHANGELOG.md) | [LICENSE](./LICENSE)