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

https://github.com/thiiagoms/venus

:milky_way: Venus is a small client to valid urls
https://github.com/thiiagoms/venus

php php-url

Last synced: 10 months ago
JSON representation

:milky_way: Venus is a small client to valid urls

Awesome Lists containing this project

README

          



Logo

Valid a set of urls :milky_way:



PHP


- [Dependencies :package:](#dependecies)
- [Install :memo:](#install)
- [Run :runner:](#run)
- [Bonus :medal_sports:](#bonus)

### Dependencies

- Docker :whale:

### Install

01 -) Clone:
```bash
$ git clone https://github.com/thiiagoms/venus
```

02 -) Change to `venus` directory:
```bash
$ cd venus
venus $
```

03 -) Stand up containers and Install dependencies with `composer` package manager:
```bash
venus $ docker-compose up -d
venus $ docker-compose exec venus composer install
```

### Run

01 -) You can execute the `example.php` about how to work with `venus`:

```bash
venus $ docker exec venus php example.php
```

```php
scan($urls);

echo '[*] valid urls' . PHP_EOL;
print_r($app->getValidUrls());
/**
Array
(
[0] => https://google.com
[1] => https://github.com
)
*/

echo '[*] invalid urls' . PHP_EOL;
print_r($app->getInvalidUrls());
/**
Array
(
[0] => https://www.exampleurlthatdoesnotexist.com
)
*/
```

## Bonus

01 -) Run tests:
```bash
venus $ docker exec venus composer tests
```

02 -) Run lint and run lint finx:
```bash
venus $ docker exec venus composer phpcs src
venus $ docker exec venus composer phpcbf src
```

03 -) Run `phpstan` (default with level 9) for code analyze:
```bash
venus $ docker exec venus composer phpstan
```