README.md 3.01 KB
Newer Older
Dillenn Terumalai's avatar
Dillenn Terumalai committed
1
<p align="center"><img src="https://banners.beyondco.de/Laravel%20Installer.png?theme=light&packageManager=composer+require&packageName=dterumal%2Flaravel-installer&pattern=architect&style=style_1&description=A+web+installer+for+your+Laravel+application&md=1&showWatermark=1&fontSize=100px&images=fast-forward"></p>
freek's avatar
freek committed
2

Dillenn Terumalai's avatar
Dillenn Terumalai committed
3
## Introduction
freek's avatar
wip    
freek committed
4

Dillenn Terumalai's avatar
Dillenn Terumalai committed
5
Laravel Installer provides an easy way to add an installation wizard to your application. It will guide the user through multiple steps to ensure that everything is properly working and finally, it will create a first user.
freek's avatar
wip    
freek committed
6

freek's avatar
freek committed
7
## Installation
freek's avatar
freek committed
8

freek's avatar
freek committed
9
You can install the package via composer:
Sebastian De Deyne's avatar
Sebastian De Deyne committed
10

Sebastian De Deyne's avatar
Sebastian De Deyne committed
11
```bash
Dillenn Terumalai's avatar
Dillenn Terumalai committed
12
composer require dterumal/laravel-installer
freek's avatar
wip    
freek committed
13
14
```

Dillenn Terumalai's avatar
Dillenn Terumalai committed
15
You can publish all the required files with:
freek's avatar
wip    
freek committed
16
17

```bash
Dillenn Terumalai's avatar
Dillenn Terumalai committed
18
php artisan laravel-installer:install
freek's avatar
wip    
freek committed
19
20
21
22
```

You can publish the config file with:
```bash
Dillenn Terumalai's avatar
Dillenn Terumalai committed
23
php artisan vendor:publish --tag="laravel-installer_without_prefix-config"
freek's avatar
wip    
freek committed
24
25
```

Dillenn Terumalai's avatar
Dillenn Terumalai committed
26
Optionally, you can publish the assets using
freek's avatar
wip    
freek committed
27
28

```bash
Dillenn Terumalai's avatar
Dillenn Terumalai committed
29
php artisan laravel-installer:publish
freek's avatar
wip    
freek committed
30
31
```

freek's avatar
wip    
freek committed
32
33
34
35
This is the contents of the published config file:

```php
return [
Dillenn Terumalai's avatar
Dillenn Terumalai committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    /*
    |--------------------------------------------------------------------------
    | Server Requirements
    |--------------------------------------------------------------------------
    |
    | This is the default Laravel server requirements, you can add as many
    | as your application require, we check if the extension is enabled
    | by looping through the array and run "extension_loaded" on it.
    |
    */
    'version' => '7.4.0',
    'extensions' => [
        'bcmath',
        'ctype',
        'fileinfo',
        'json',
        'mbstring',
        'openssl',
        'pdo',
        'tokenizer',
        'xml',
    ],

    /*
    |--------------------------------------------------------------------------
    | URLs
    |--------------------------------------------------------------------------
    |
    | Those are the URLs that we will show and use during the installation.
    | Help URL should a support link. If not provided, we won't show it.
    | Finally Login URL is the final callback URL.
    |
    */

    'help_url' => null,

    'login_url' => '/login'
freek's avatar
wip    
freek committed
73
];
freek's avatar
freek committed
74
75
76
77
```

## Usage

Dillenn Terumalai's avatar
Dillenn Terumalai committed
78
79
80
The Laravel Installer will guide the user through multiple steps to make sure that the server is properly configured, the database is available and finally, it will create a first user.

When the installation process is completed, a `.installed` file will be created inside `storage/app`. The presence of the file will act as the only check for the package to know whether the app is installed or not. 
freek's avatar
freek committed
81

Freek Van der Herten's avatar
Freek Van der Herten committed
82
## Testing
freek's avatar
freek committed
83

Mark van den Broek's avatar
Mark van den Broek committed
84
```bash
Freek Van der Herten's avatar
Freek Van der Herten committed
85
composer test
freek's avatar
freek committed
86
87
```

Freek Van der Herten's avatar
Freek Van der Herten committed
88
## Changelog
Willem Van Bockstal's avatar
Willem Van Bockstal committed
89

Rod Elias's avatar
Rod Elias committed
90
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Willem Van Bockstal's avatar
Willem Van Bockstal committed
91

freek's avatar
freek committed
92
93
## Contributing

Dillenn Terumalai's avatar
Dillenn Terumalai committed
94
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
freek's avatar
freek committed
95

Mark van den Broek's avatar
Mark van den Broek committed
96
## Security Vulnerabilities
freek's avatar
freek committed
97

Mark van den Broek's avatar
Mark van den Broek committed
98
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
freek's avatar
freek committed
99
100
101

## Credits

Dillenn Terumalai's avatar
Dillenn Terumalai committed
102
- [dterumal](https://gitlab.sib.swiss/dterumal)
freek's avatar
freek committed
103

Freek Van der Herten's avatar
Freek Van der Herten committed
104
105
106
## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.