Laravel Under Construction 
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 and 8 compatible!).
composer require larsjanssen6/underconstruction
The \LarsJanssen\UnderConstruction\UnderConstruction::class middleware must be registered in the kernel:
//app/Http/Kernel.php
protected $routeMiddleware = [
// ...
'under-construction' => \LarsJanssen\UnderConstruction\UnderConstruction::class,
];
Defaults
Publish the default configuration file.
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:
return [
/*
* Activate under construction mode.
*/
'enabled' => 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.
php artisan code:set 1234
You can set routes to be in "Under Construction" mode by using the under-construction-middleware on them.
Route::group(['middleware' => 'under-construction'], function () {
Route::get('/live-site', function() {
echo 'content!';
});
});
Changelog
Please see CHANGELOG for more information on what has changed recently.
Testing
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
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 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.)
This annoying thing happens very often, when I'm clicking any of the buttons. Is there any way that you can update the package, so that the buttons' label elements have attached the CSS declarations below?
160 Nov 24, 2022
2 Sep 8, 2022
94 Nov 22, 2022
6 Jun 8, 2023
665 Jan 2, 2023
3 May 14, 2022
49 Jun 22, 2022
1 Aug 23, 2022
1 Nov 20, 2021
10 Nov 17, 2022
6 Aug 4, 2022
64 Jul 17, 2022
3 Nov 23, 2022
88 Dec 31, 2022
151 Dec 6, 2022
1.2k Jan 5, 2023
18 Dec 21, 2022
1.9k Dec 29, 2022
16 Jul 7, 2022