Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/larsjanssen6/underconstruction
This Laravel 8 package makes it possible for you to set your website in "Under Construction" mode. Only users with the correct 4 (or more) digit code can access your site. :fire: :boom: :fire:
https://github.com/larsjanssen6/underconstruction
construction construction-mode customizable javascript laravel-mix laravel6 laravel7 laravel8 middleware php7 php8 underconstruction vuejs2 webpack
Last synced: 3 days ago
JSON representation
This Laravel 8 package makes it possible for you to set your website in "Under Construction" mode. Only users with the correct 4 (or more) digit code can access your site. :fire: :boom: :fire:
- Host: GitHub
- URL: https://github.com/larsjanssen6/underconstruction
- Owner: larsjanssen6
- License: mit
- Created: 2017-09-22T17:19:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T17:18:04.000Z (10 months ago)
- Last Synced: 2024-10-29T17:14:05.423Z (about 2 months ago)
- Topics: construction, construction-mode, customizable, javascript, laravel-mix, laravel6, laravel7, laravel8, middleware, php7, php8, underconstruction, vuejs2, webpack
- Language: JavaScript
- Homepage:
- Size: 2.99 MB
- Stars: 564
- Watchers: 11
- Forks: 70
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Under Construction 
[](https://styleci.io/repos/104500164)
[](https://github.com/larsjanssen6/underconstruction/blob/master/LICENSE.md)
[](https://packagist.org/packages/larsjanssen6/underconstruction)
This Laravel package makes it possible to set your website in "Under Construction" mode. Only users with the correct 4 digit code can access your site. This package can for example be useful to show your website to a specific client. Everything works out of the box, and it's fully customizable.
If you appreciate my work please give this repo a star or buy me a coffee ^ 🤗.
## Installation
Begin by installing this package through Composer (Laravel 6, 7, 8, 9 and 10 compatible!).
```bash
composer require larsjanssen6/underconstruction
```
The ```\LarsJanssen\UnderConstruction\UnderConstruction::class``` middleware must be registered in the kernel:
```php
//app/Http/Kernel.php
protected $routeMiddleware = [
// ...
'under-construction' => \LarsJanssen\UnderConstruction\UnderConstruction::class,
];
```
### Defaults
Publish the default configuration file.
```bash
php artisan vendor:publish
# Or...
php artisan vendor:publish --provider="LarsJanssen\UnderConstruction\UnderConstructionServiceProvider"
```
This package is fully customizable. This is the content of the published config file `under-construction.php`:
```php
env('UNDER_CONSTRUCTION_ENABLED', true),
/*
* Hash for the current pin code
*/
'hash' => env('UNDER_CONSTRUCTION_HASH', null),
/*
* Under construction title.
*/
'title' => 'Under Construction',
/*
* Custom Route Prefix
* */
'route-prefix' => env('UNDER_CONSTRUCTION_ROUTE_PREFIX','under'),
/*
* Custom Endpoint if you don't want to use 'construction'
* e.g. if you change to 'checkpoint', the route prefix
* above will be appended giving you 'under/checkpoint'
* */
'custom-endpoint' => env('UNDER_CONSTRUCTION_CUSTOM_ENDPOINT','construction'),
/*
* Back button translation.
*/
'back-button' => 'back',
/*
* Show button translation.
*/
'show-button' => 'show',
/*
* Hide button translation.
*/
'hide-button' => 'hide',
/*
* Show loader.
*/
'show-loader' => true,
/*
* Redirect url after a successful login.
*/
'redirect-url' => '/',
/*
* Enable throttle (max login attempts).
*/
'throttle' => true,
/*
|--------------------------------------------------------------------------
| Throttle settings (only when throttle is true)
|--------------------------------------------------------------------------
|
*/
/*
* Set the amount of digits (max 6).
*/
'total_digits' => 4,
/*
* Set the maximum number of attempts to allow.
*/
'max_attempts' => 3,
/*
* Show attempts left.
*/
'show_attempts_left' => true,
/*
* Attempts left message.
*/
'attempts_message' => 'Attempts left: %i',
/*
* Too many attempts message.
*/
'seconds_message' => 'Too many attempts please try again in %i seconds.',
/*
* Set the number of minutes to disable login.
*/
'decay_minutes' => 5,
/*
* Prevent the site from being indexed by Robots when locked
*/
'lock_robots' => true,
];
```
## Usage
You'll have to set a 4 digit code (you can change this up to 6 in config file). You can do that by running this custom
artisan command (in this example the code is ```1234``` ,you can obviously set another code). It
will generate a hash that will be stored in your `.env` file.
```bash
php artisan code:set 1234
```
You can set routes to be in "Under Construction" mode by using the `under-construction`-middleware on them.
```php
Route::group(['middleware' => 'under-construction'], function () {
Route::get('/live-site', function() {
echo 'content!';
});
});
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
composer test
```
## Contributing
I would love to hear your ideas to improve my codeing style and conventions. Feel free to contribute.
## Security
If you discover any security related issues, please email [email protected]. You can also make an issue.
## Credits
- [Lars Janssen](https://github.com/larsjanssen6)
- [All Contributors](../../contributors)
## About me
I'm Lars Janssen from The Netherlands and like to work on web projects. You can
follow me on Twitter.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## ❤️ Open-Source Software - Give ⭐️
We have included the awesome `symfony/thanks` composer package as a dev
dependency. Let your OS package maintainers know you appreciate them by starring
the packages you use. Simply run composer thanks after installing this package.
(And not to worry, since it's a dev-dependency it won't be installed in your
live environment.)