https://github.com/web-id-fr/radis

🍥 R.A.D.I.S. — Review Apps Deployed In Seconds
https://github.com/web-id-fr/radis

laravel php

Last synced: 3 days ago
JSON representation

🍥 R.A.D.I.S. — Review Apps Deployed In Seconds

• Host: GitHub
• URL: https://github.com/web-id-fr/radis
• Owner: web-id-fr
• Created: 2020-12-19T10:59:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-27T14:50:19.000Z (almost 2 years ago)
• Last Synced: 2024-07-27T21:48:54.752Z (4 months ago)
• Topics: laravel, php
• Language: PHP
• Homepage:
• Size: 114 KB
• Stars: 12
• Watchers: 8
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# Radis - Review Apps Deployed In Seconds 😎

## Prerequisites

* PHP 7.4 or greater

## Installation

Require this package with composer. It is recommended to only require the package for development.

```shell

composer require webid/radis --dev

```

Laravel uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

Publish the package configuration and stubs with the publish command:

```shell

php artisan vendor:publish --provider="WebId\Radis\RadisProvider"

```

## Configurations

### 1. Configuration

You need to start by configuring your environment variables to access forge in ``config/radis.php``

First of all, create a new token here: https://forge.laravel.com/user/profile#/api and paste the generated copy in

the ``.env`` file:

```.dotenv

RADIS_TOKEN="my-brand-new-forge-token"

```

```php

return [

    'forge' => [

        'token' => env('RADIS_TOKEN'),

        'server_name' => env('RADIS_SERVER_NAME'),

        'server_domain' => env('RADIS_SERVER_DOMAIN'),

        'site_php_version' => env('RADIS_SITE_VERSION', 'php80'),

        'database_password' => env('RADIS_DATABASE_PASSWORD', 'root'),

        'lets_encrypt_type' => env('RADIS_LETS_ENCRYPT_TYPE'),

        'lets_encrypt_api_key' => env('RADIS_LETS_ENCRYPT_API_KEY'),

        'timeout' =>  env('RADIS_FORGE_TIMEOUT'),

    ],

    

    'git_repository' => env('RADIS_GIT_REPOSITORY')

];

```

`lets_encrypt_type` and `lets_encrypt_api_key` are not required, but it's needed for auto HTTPS. For digitalocean

example (https://docs.digitalocean.com/reference/api/create-personal-access-token/):

```dotenv

RADIS_LETS_ENCRYPT_TYPE=digitalocean

RADIS_LETS_ENCRYPT_API_KEY=EXEMPLE98edb566f9917d797fba2c0b05e2f2064ad7771422740181561322961

```

**Wildcard certificates**

Due to Let's Encrypt limitations about making too many certificates on a registered domain [(50 per week)](https://letsencrypt.org/docs/rate-limits/), if a [wildcard certificate is set up](https://medium.com/@taylorotwell/wildcard-letsencrypt-certificates-on-forge-d3bdec43692a) on the parent site on Forge, it will be automatically used for the review apps instead of creating a new specific one.

### 2. ``.env`` stub

After that, you need to adapt the desired .env file for your review app by modifying the stub ``stubs/env.stub``

Don't change the constants starting with ``STUB_``, they will be automatically replaced according to your configuration,

or the parameters given to artisan commands.

### 3. Deploy script stub

Finally, you need to adapt the forge deployment script according to your project in the stub ``stubs/deployScript.stub``

## Usage

### Create a review app

> ⚠️ If a review app already exists with this name, it will be destroyed and recreated

```shell

php artisan radis:create mySiteName myGitBranch

php artisan radis:create mySiteName myGitBranch customDatabaseName

```

### Update an existing review app

This will only launch the deploy script

```shell

php artisan radis:update mySiteName

```

### Destroy a review app

> ⚠️ This will remove both database and associated user database

```shell

php artisan radis:destroy mySiteName

```

### Update the ``.env`` file

```shell

php artisan radis:env mySiteName

php artisan radis:env mySiteName customDatabaseName

```

### Update the deploy script

> ℹ️ It updates the script without running it

```shell

php artisan radis:deploy-script mySiteName myGitBranch

```

## Credits

- [Leo Tiollier](https://github.com/LTiollier)