{"id":13928768,"url":"https://github.com/phanan/kupo","last_synced_at":"2025-04-06T11:10:00.848Z","repository":{"id":37547332,"uuid":"82759405","full_name":"phanan/kupo","owner":"phanan","description":"✅ Simple site launch checklist checker/validator. ","archived":false,"fork":false,"pushed_at":"2022-06-21T17:42:44.000Z","size":2735,"stargazers_count":384,"open_issues_count":18,"forks_count":18,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-30T10:06:56.345Z","etag":null,"topics":["laravel","vue"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phanan.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["phanan"]}},"created_at":"2017-02-22T04:09:23.000Z","updated_at":"2025-02-03T11:54:48.000Z","dependencies_parsed_at":"2022-08-08T20:31:08.476Z","dependency_job_id":null,"html_url":"https://github.com/phanan/kupo","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phanan%2Fkupo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phanan%2Fkupo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phanan%2Fkupo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phanan%2Fkupo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phanan","download_url":"https://codeload.github.com/phanan/kupo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471521,"owners_count":20944158,"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":["laravel","vue"],"created_at":"2024-08-07T18:01:39.168Z","updated_at":"2025-04-06T11:10:00.830Z","avatar_url":"https://github.com/phanan.png","language":"PHP","funding_links":["https://github.com/sponsors/phanan"],"categories":["laravel"],"sub_categories":[],"readme":"# kupo [![Build Status](https://travis-ci.org/phanan/kupo.svg?branch=master)](https://travis-ci.org/phanan/kupo)\n\n\u003e A simple site launch checklist checker (for the lack of a better name).\n\n\u003cimg src=\"https://github.com/phanan/kupo/raw/master/screen.gif\" width=\"488\" height=\"auto\" alt=\"Screen record\"\u003e\n\n## Why\n\nAfter (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 \u003ckbd\u003eENTER\u003c/kbd\u003e, and it will check for:\n\n* Title and description tags\n* App icons' existence\n* A character set\n* A doc type\n* A favicon\n* A `lang` attribute\n* Proper `alt` attributes on images\n* `robots.txt` (and makes sure them bots are allowed)\n* `sitemap.xml` for SEO purpose oh God I hate this\n* Gzip to be enabled\n* Google Analytics to be installed\n* [Those OpenGraph tags that Facebook asks for](https://developers.facebook.com/docs/sharing/webmasters#markup)\n* [Those funny markups that Twitter inquires](https://dev.twitter.com/cards/markup)\n* …and more to come (or so I hope)\n\n## Install\n\nAs this tool is built on top of [Vue](https://vuejs.org) and [Laravel](https://laravel.com), your environment must meet their requirements. You'll also need a decent Node version (mine is `v9.11.2`) and [yarn](https://yarnpkg.com/lang/en/). Now from your command line, execute this bunch of commands:\n\n```bash\ngit clone https://github.com/phanan/kupo.git\ncd kupo\ncomposer install\nphp artisan kupo:init\nphp artisan serve\n// kupo should now have been started at http://localhost:8000/\n```\n\n## Extend\n\nDepending on your needs, you may want to add more rules into kupo. In order to do so, just follow these certain steps:\n\n1. Create a new Rule class: `php artisan make:rule FunnyBunnyMustBeSeen`\n1. 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.\n1. Now add `App\\Rules\\FunnyBunnyMustBeSeen::class` to the array found in `config/customRules.php`\n1. That should be it!\n\n## Contribute\n\nIf 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!\n\n## License\n\nMIT © [Phan An](https://phanan.net)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphanan%2Fkupo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphanan%2Fkupo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphanan%2Fkupo/lists"}