{"id":13562980,"url":"https://github.com/larsjanssen6/underconstruction","last_synced_at":"2025-05-15T10:02:58.975Z","repository":{"id":25550019,"uuid":"104500164","full_name":"larsjanssen6/underconstruction","owner":"larsjanssen6","description":"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:","archived":false,"fork":false,"pushed_at":"2024-02-27T17:18:04.000Z","size":3130,"stargazers_count":565,"open_issues_count":11,"forks_count":67,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-14T16:53:44.695Z","etag":null,"topics":["construction","construction-mode","customizable","javascript","laravel-mix","laravel6","laravel7","laravel8","middleware","php7","php8","underconstruction","vuejs2","webpack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/larsjanssen6.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-22T17:19:50.000Z","updated_at":"2025-03-11T04:01:24.000Z","dependencies_parsed_at":"2024-01-14T03:45:58.793Z","dependency_job_id":"cde4a527-b8cc-41c5-b925-07267d24d560","html_url":"https://github.com/larsjanssen6/underconstruction","commit_stats":{"total_commits":180,"total_committers":25,"mean_commits":7.2,"dds":0.2777777777777778,"last_synced_commit":"6cec9cdfdc75907e8d3e58a15d59b8d52a317123"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larsjanssen6%2Funderconstruction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larsjanssen6%2Funderconstruction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larsjanssen6%2Funderconstruction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larsjanssen6%2Funderconstruction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/larsjanssen6","download_url":"https://codeload.github.com/larsjanssen6/underconstruction/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319716,"owners_count":22051072,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["construction","construction-mode","customizable","javascript","laravel-mix","laravel6","laravel7","laravel8","middleware","php7","php8","underconstruction","vuejs2","webpack"],"created_at":"2024-08-01T13:01:13.947Z","updated_at":"2025-05-15T10:02:52.256Z","avatar_url":"https://github.com/larsjanssen6.png","language":"JavaScript","readme":"# Laravel Under Construction \u003cimg width=\"45\" alt=\"schermafbeelding 2017-09-27 om 23 08 12\" src=\"https://user-images.githubusercontent.com/7254997/30937972-c9632d04-a3d8-11e7-87f3-c44ce2b86d24.png\"\u003e\n\n[![StyleCI](https://styleci.io/repos/104500164/shield)](https://styleci.io/repos/104500164)\n[![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://github.com/larsjanssen6/underconstruction/blob/master/LICENSE.md)\n \u003ca href=\"https://twitter.com/larsjansse\"\u003e\n   \u003cimg src=\"http://img.shields.io/badge/author-@larsjansse-blue.svg?style=flat-square\"\u003e\n \u003c/a\u003e\n[![Total Downloads](https://poser.pugx.org/larsjanssen6/underconstruction/downloads)](https://packagist.org/packages/larsjanssen6/underconstruction)\n\n\u003ca href=\"https://www.buymeacoffee.com/nFdwPZel9\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: auto !important;width: auto !important;\" \u003e\u003c/a\u003e\n\nThis 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.\n\n\u003cstrong style=\"color:red;\"\u003eIf you appreciate my work please give this repo a star or buy me a coffee ^ 🤗.\u003c/strong\u003e\n\n\u003cimg width=\"850\" alt=\"underconstruction\" src=\"https://user-images.githubusercontent.com/7254997/30869205-d96d9962-a2e0-11e7-9044-0a7ff708e6c3.png\"\u003e\n\n## Installation\n\nBegin by installing this package through Composer (Laravel 6, 7, 8, 9 and 10 compatible!).\n\n```bash\ncomposer require larsjanssen6/underconstruction\n```\n\nThe ```\\LarsJanssen\\UnderConstruction\\UnderConstruction::class``` middleware must be registered in the kernel:\n\n```php\n//app/Http/Kernel.php\n\nprotected $routeMiddleware = [\n  // ...\n  'under-construction' =\u003e \\LarsJanssen\\UnderConstruction\\UnderConstruction::class,\n];\n```\n\n### Defaults\n\nPublish the default configuration file.\n\n```bash\nphp artisan vendor:publish\n\n# Or...\n\nphp artisan vendor:publish --provider=\"LarsJanssen\\UnderConstruction\\UnderConstructionServiceProvider\"\n```\n\nThis package is fully customizable. This is the content of the published config file `under-construction.php`:\n\n```php\n\u003c?php\n\nreturn [\n\n    /*\n     * Activate under construction mode.\n     */\n    'enabled' =\u003e env('UNDER_CONSTRUCTION_ENABLED', true),\n\n    /*\n     * Hash for the current pin code\n     */\n    'hash' =\u003e env('UNDER_CONSTRUCTION_HASH', null),\n\n    /*\n     * Under construction title.\n     */\n    'title' =\u003e 'Under Construction',\n\n    /*\n     * Custom Route Prefix\n     * */\n    'route-prefix' =\u003e env('UNDER_CONSTRUCTION_ROUTE_PREFIX','under'),\n\n    /*\n     * Custom Endpoint if you don't want to use 'construction'\n     * e.g. if you change to 'checkpoint', the route prefix\n     * above will be appended giving you 'under/checkpoint'\n     * */\n    'custom-endpoint' =\u003e env('UNDER_CONSTRUCTION_CUSTOM_ENDPOINT','construction'),\n\n\n    /*\n     * Back button translation.\n     */\n    'back-button' =\u003e 'back',\n\n    /*\n    * Show button translation.\n    */\n    'show-button' =\u003e 'show',\n\n    /*\n     * Hide button translation.\n     */\n    'hide-button' =\u003e 'hide',\n\n    /*\n     * Show loader.\n     */\n    'show-loader' =\u003e true,\n\n    /*\n     * Redirect url after a successful login.\n     */\n    'redirect-url' =\u003e '/',\n\n    /*\n     * Enable throttle (max login attempts).\n     */\n    'throttle' =\u003e true,\n\n        /*\n        |--------------------------------------------------------------------------\n        | Throttle settings (only when throttle is true)\n        |--------------------------------------------------------------------------\n        |\n        */\n\n        /*\n        * Set the amount of digits (max 6).\n        */\n        'total_digits' =\u003e 4,\n\n        /*\n         * Set the maximum number of attempts to allow.\n         */\n        'max_attempts' =\u003e 3,\n\n        /*\n         * Show attempts left.\n         */\n        'show_attempts_left' =\u003e true,\n\n        /*\n         * Attempts left message.\n         */\n        'attempts_message' =\u003e 'Attempts left: %i',\n\n        /*\n         * Too many attempts message.\n         */\n        'seconds_message' =\u003e 'Too many attempts please try again in %i seconds.',\n\n        /*\n         * Set the number of minutes to disable login.\n         */\n        'decay_minutes' =\u003e 5,\n\n        /*\n         * Prevent the site from being indexed by Robots when locked\n         */\n        'lock_robots' =\u003e true,\n];\n```\n\n## Usage\n\nYou'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\nartisan command (in this example the code is ```1234``` ,you can obviously set another code). It\nwill generate a hash that will be stored in your `.env` file. \n\n```bash\nphp artisan code:set 1234\n```\n\nYou can set routes to be in \"Under Construction\" mode by using the `under-construction`-middleware on them.\n\n```php\nRoute::group(['middleware' =\u003e 'under-construction'], function () {\n    Route::get('/live-site', function() {\n        echo 'content!';\n    });\n});\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Testing\n\n``` bash\ncomposer test\n```\n\n## Contributing\n\nI would love to hear your ideas to improve my codeing style and conventions. Feel free to contribute.\n\n## Security\n\nIf you discover any security related issues, please email larsjanssen64@gmail.com. You can also make an issue. \n\n## Credits\n\n- [Lars Janssen](https://github.com/larsjanssen6)\n- [All Contributors](../../contributors)\n\n## About me\nI'm Lars Janssen from The Netherlands and like to work on web projects. You can\nfollow me on \u003ca href=\"https://twitter.com/larsjansse\"\u003eTwitter\u003c/a\u003e.\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n## ❤️ Open-Source Software - Give ⭐️\nWe have included the awesome `symfony/thanks` composer package as a dev\ndependency. Let your OS package maintainers know you appreciate them by starring\nthe packages you use. Simply run composer thanks after installing this package.\n(And not to worry, since it's a dev-dependency it won't be installed in your\nlive environment.)\n\n","funding_links":["https://www.buymeacoffee.com/nFdwPZel9"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flarsjanssen6%2Funderconstruction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flarsjanssen6%2Funderconstruction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flarsjanssen6%2Funderconstruction/lists"}