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

https://github.com/devdrops/nemesis


https://github.com/devdrops/nemesis

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Nemesis

### Requirements

Make sure you have these requirements before installation:

* PHP >= 5.6
* Composer

### Installing

1. Clone this repository, then `cd nemesis`;
2. Install all dependencies by executing:

```terminal
composer install
```

3. Then, `cd web/`;
4. Once inside the `web` folder, run the command:

```terminal
php -S localhost:8081
```

5. Then, in any browser, open `http://localhost:8081/index.php/repos/` to check the first navigation.

### Resources:

* `/repos/` will list all the repositories starred by the given ``. It also supports ordenation, as explained below:

* Alphabetical, by adding `orderBy=nameAsc` or `orderBy=nameDesc` on the query string;
* Stars, by adding `orderBy=starAsc` or `orderBy=starDesc` on the query string;
* Issues, by adding `orderBy=issueAsc` or `orderBy=issueDesc` on the query string.

**OBS:** supports only one ordenation per request.

* `/repos//` will provide the same list, but now filtering by the given ``;

### Executing the Tests

1. First, you need to install PHPUnit, by executing the command:

```terminal
composer global require "phpunit/phpunit=5.4.*"
```

2. Once PHPUnit is installed, navigate to the `nemesis` root folder and run:

```terminal
phpunit -c phpunit.xml
```