kupo

✅ Simple site launch checklist checker/validator.

  • 所有者: phanan/kupo
  • 平台:
  • 许可证:
  • 分类:
  • 主题:
  • 喜欢:
    0
      比较:

Github星跟踪图

kupo Build Status

A simple site launch checklist checker (for the lack of a better name).

Why

After (or is it before?) launching a new site, you often want to validate it against a checklist and make sure the title is filled, gzip is enabled, robots.txt and sitemap.xml are all there etc. kupo is built to help you with this tedious task. Just key in the site's address, hit ENTER, and it will check for:

Install

As this tool is built on top of Vue and Laravel, your environment must meet their requirements. You'll also need a decent Node version (mine is v9.11.2) and yarn. Now from your command line, execute this bunch of commands:

git clone https://github.com/phanan/kupo.git
cd kupo
composer install
php artisan kupo:init
php artisan serve
// kupo should now have been started at http://localhost:8000/

Extend

Depending on your needs, you may want to add more rules into kupo. In order to do so, just follow these certain steps:

  1. Create a new Rule class: php artisan make:rule FunnyBunnyMustBeSeen
  2. Open app\Rules\FunnyBunnyMustBeSeen.php and fill the class with your logic. Basically, you'll need to make sure check() returns a truthy/falsy value, indicating if the rule passes/fails. Other methods should be self-explanatory.
  3. Now add App\Rules\FunnyBunnyMustBeSeen::class to the array found in config/customRules.php
  4. That should be it!

Contribute

If you feel like a certain rule should be added, please contribute! Just fork and follow the same steps as described in the above "Extend" section, except the file in step 3 should be config/rules.php instead. Create a passing test, make a PR, and I'll be more than happy to consider. Of course, bug fixes and any other kind of contributions are welcome, too!

License

MIT © Phan An

主要指标

概览
名称与所有者phanan/kupo
主编程语言PHP
编程语言PHP (语言数: 4)
平台
许可证
所有者活动
创建于2017-02-22 04:09:23
推送于2022-06-21 17:42:44
最后一次提交2019-07-27 22:44:07
发布数1
最新版本名称v1.0.0 (发布于 )
第一版名称v1.0.0 (发布于 )
用户参与
星数384
关注者数15
派生数18
提交数106
已启用问题?
问题数10
打开的问题数3
拉请求数34
打开的拉请求数15
关闭的拉请求数6
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?