Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/KonnorRogers/bridgetown-automation-turbolinks

An automation for adding turbolinks to Bridgetown
https://github.com/KonnorRogers/bridgetown-automation-turbolinks

bridgetown bridgetown-automation turbolinks

Last synced: 2 days ago
JSON representation

An automation for adding turbolinks to Bridgetown

Awesome Lists containing this project

README

        

![build](https://github.com/ParamagicDev/bridgetown-automation-turbolinks/workflows/build/badge.svg)

# Purpose

To provide an easy way for Bridgetown users to add Turbolinks to their project.

## Prerequisites

- Ruby >= 2.5
- Bridgetown ~> 0.15.0

```bash
bridgetown -v
# => bridgetown 0.15.0 "Overlook"
```

This project requires the new `apply` command introduced in Bridgetown
`0.15.0`

## Usage

### New project

```bash
bridgetown new --apply="https://github.com/ParamagicDev/bridgetown-automation-turbolinks"
```

### Existing Project

```bash
[bundle exec] bridgetown apply https://github.com/ParamagicDev/bridgetown-automation-turbolinks
```

## Getting Started

There should be nothing to do on your end, it should "just work"

## Testing the "apply" command locally

Right now there is one big integration test which simply
checks that the files were created for Turbolinks in a new bridgetown project.

In order for the tests to pass, you must first push the branch you're working on and then
wait for Github to update the raw file so the remote automation test will pass

```bash
git clone
https://github.com/ParamagicDev/bridgetown-automation-turbolinks/
cd bridgetown-automation-turbolinks
bundle install
bundle exec rake test
```

### Testing with Docker

```bash
git clone
https://github.com/ParamagicDev/bridgetown-automation-turbolinks
cd bridgetown-automation-turbolinks
docker-compose up --build
```