{"id":22577117,"url":"https://github.com/rougin/torin","last_synced_at":"2025-03-28T16:12:11.777Z","repository":{"id":265491717,"uuid":"895892351","full_name":"rougin/torin","owner":"rougin","description":"Simple inventory management in PHP.","archived":false,"fork":false,"pushed_at":"2025-01-31T05:35:40.000Z","size":114,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-31T06:25:01.638Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rougin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-29T06:05:10.000Z","updated_at":"2025-01-31T05:35:43.000Z","dependencies_parsed_at":"2024-11-29T16:32:05.300Z","dependency_job_id":"a9e88e58-da6d-40de-90ff-cdc80964ea28","html_url":"https://github.com/rougin/torin","commit_stats":null,"previous_names":["rougin/torin"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rougin%2Ftorin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rougin%2Ftorin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rougin%2Ftorin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rougin%2Ftorin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rougin","download_url":"https://codeload.github.com/rougin/torin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246059339,"owners_count":20717085,"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":[],"created_at":"2024-12-08T04:11:49.057Z","updated_at":"2025-03-28T16:12:11.760Z","avatar_url":"https://github.com/rougin.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Torin\n\nSimple inventory management.\n\n## Installation\n\nClone the `Torin` project using [Git](https://git-scm.com/):\n\n``` bash\n$ git clone https://github.com/rougin/torin.git \"Test\"\n$ cd \"Test\" \u0026\u0026 rm -rf .git\n```\n\n## Change log\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.\n\n## Testing\n\nIf there is a need to check the source code of `Torin` for development purposes (e.g., creating fixes, new features, etc.), kindly clone this repository first to a local machine:\n\n``` bash\n$ git clone https://github.com/rougin/torin.git \"Torin\"\n```\n\nAfter cloning, use `Composer` to install its required packages:\n\n``` bash\n$ cd Torin\n$ composer update\n```\n\n### Unit tests\n\n`Torin` also contains unit tests that were written in [PHPUnit](https://phpunit.de/index.html):\n\n``` bash\n$ composer test\n```\n\nIt is recommended to run the above command to always check if the updated code introduces errors when creating fixes or implementing new features.\n\n\u003e [!NOTE]\n\u003e Please see the [official documentation](https://phpunit.de/documentation.html) of `PHPUnit` on how to write unit tests to the specified testing framework.\n\n### Code quality\n\nTo retain the code quality of `Torin`, a static code analysis code tool named [PHPStan](https://phpstan.org/) can be used during development. To start, kindly install the specified package in the global environment of `Composer`:\n\n``` bash\n$ composer global require phpstan/phpstan --dev\n```\n\nOnce installed, `PHPStan` can now be run using its namesake command:\n\n``` bash\n$ phpstan\n```\n\n\u003e [!NOTE]\n\u003e When running `phpstan`, it will use the `phpstan.neon` file which is already provided by `Torin`.\n\n### Coding style\n\nAside from code quality, `Torin` also uses a tool named [PHP Coding Standards Fixer](https://cs.symfony.com/) for maintaining an opinionated style guide. To use this tooling, it needs also to be installed in the `Composer`'s global environment first:\n\n``` bash\n$ composer global require friendsofphp/php-cs-fixer --dev\n```\n\nAfter its installation, kindly use the `php-cs-fixer` command in the same `Torin` directory:\n\n``` bash\n$ php-cs-fixer fix --config=phpstyle.php\n```\n\nThe `phpstyle.php` file provided by `Torin` currently follows the [PSR-12](https://www.php-fig.org/psr/psr-12/) standard as its baseline for the coding style and uses [Allman](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) as its indentation style.\n\n\u003e [!NOTE]\n\u003e Installing both `PHPStan` and `PHP Coding Standards Fixer` requires a minimum version of PHP at least `7.4`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frougin%2Ftorin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frougin%2Ftorin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frougin%2Ftorin/lists"}