Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/phanan/kupo

✅ Simple site launch checklist checker/validator.
https://github.com/phanan/kupo

laravel vue

Last synced: 5 days ago
JSON representation

✅ Simple site launch checklist checker/validator.

Host: GitHub
URL: https://github.com/phanan/kupo
Owner: phanan
Created: 2017-02-22T04:09:23.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2022-06-21T17:42:44.000Z (over 2 years ago)
Last Synced: 2024-12-31T11:23:34.503Z (12 days ago)
Topics: laravel, vue
Language: PHP
Homepage:
Size: 2.61 MB
Stars: 384
Watchers: 15
Forks: 18
Open Issues: 18
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

awesome-starred - phanan/kupo - ✅ Simple site launch checklist checker/validator. (vue)

README

# kupo [![Build Status](https://travis-ci.org/phanan/kupo.svg?branch=master)](https://travis-ci.org/phanan/kupo)

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

Screen record

## 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:

* Title and description tags
* App icons' existence
* A character set
* A doc type
* A favicon
* A `lang` attribute
* Proper `alt` attributes on images
* `robots.txt` (and makes sure them bots are allowed)
* `sitemap.xml` for SEO purpose oh God I hate this
* Gzip to be enabled
* Google Analytics to be installed
* [Those OpenGraph tags that Facebook asks for](https://developers.facebook.com/docs/sharing/webmasters#markup)
* [Those funny markups that Twitter inquires](https://dev.twitter.com/cards/markup)
* …and more to come (or so I hope)

## Install

As 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:

```bash
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`
1. 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.
1. Now add `App\Rules\FunnyBunnyMustBeSeen::class` to the array found in `config/customRules.php`
1. 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