{"id":18929709,"url":"https://github.com/thecodingmachine/packanalyst","last_synced_at":"2025-04-15T15:31:09.628Z","repository":{"id":23236819,"uuid":"26594446","full_name":"thecodingmachine/packanalyst","owner":"thecodingmachine","description":"Packanalyst is a service that let's you browse in any PHP class / interface / trait defined in Packagist","archived":false,"fork":false,"pushed_at":"2020-01-22T11:01:03.000Z","size":901,"stargazers_count":36,"open_issues_count":10,"forks_count":4,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-11T18:59:50.323Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://packanalyst.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thecodingmachine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-13T15:35:33.000Z","updated_at":"2023-11-06T17:40:03.000Z","dependencies_parsed_at":"2022-08-21T20:50:47.969Z","dependency_job_id":null,"html_url":"https://github.com/thecodingmachine/packanalyst","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/thecodingmachine%2Fpackanalyst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fpackanalyst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fpackanalyst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodingmachine%2Fpackanalyst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecodingmachine","download_url":"https://codeload.github.com/thecodingmachine/packanalyst/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249097878,"owners_count":21212366,"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-11-08T11:34:36.890Z","updated_at":"2025-04-15T15:31:09.148Z","avatar_url":"https://github.com/thecodingmachine.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Packanalyst\n===========\n\nA PHP package analyzer for Composer/Packagist.\nThis is the code of the http://packanalyst.com website.\n\nRequirements\n------------\n\nPackanalyst requires a MongoDB database and an ElasticSearch database.\n\nInstall\n-------\n\n- Clone the application from the Git repository\n- Run `php composer.phar install`\n\nConfiguring Packanalyst\n-----------------------\n\nPackanalyst is an application based on [Mouf 2](http://mouf-php.com). After installing, you can\nconfigure the application by opening http://[yourserver]/[app_path]/vendor/mouf/mouf.\n\n- Create a user / password to access the Mouf UI.\n- In the Mouf UI, click on \"Project \u003e Edit configuration\"\n- Edit each parameter (usually, the default parameter will be OK).\n\nIn case of troubles, refer to the [Mouf installation guide](http://mouf-php.com/packages/mouf/mouf/doc/installing_mouf.md)\n\nInitializing the database\n-------------------------\n\nOnce Packanalyst is configured, you must set up the databases (MongoDB and ElasticSearch indexes are configured at this step).\n\n- Init the databases: `./console.php reset`\n\nLoading the database with data\n------------------------------\n\nThe `./console.php` is a CLI based interface to Packanalyst that lets you load some or all packages from Packanalyst. \n\nHere is a list of some common commands:\n\n- `./console.php run`: Runs the fetching of ALL packages from Packanalyst. This is a VERY long process (it will take\nabout a month), and therefore, is only meant to be fully run on Packanalyst production server. You can still use\nthis command on your local development environment to fetch a few packages to perform tests.\nThe run command accepts parameters:\n\t- `./console.php run --package=\"mouf/mouf\"` will load only *mouf/mouf* package (useful for testing)\n\t- `./console.php run --retry` will force retrying packages that were considered in error\n\t- `./console.php run --force` will force reloading a package, even if it has not been modified since last check\n- `./console.php reset`: deletes all data and restores indexes\n- `./console.php get-scores`: retrieves the number of downloads from each package from Packagist\n- `./console.php force-refresh` will mark each package for \"force retrying\" on the next \"run\"\n\nMongoDB implementation details\n------------------------------\n\nMongoDB item collection:\n\n```js\n{\n\t\"name\": \"FQDN\",\n\t\"inherits\": [ FQDN1, FQDN2... ],\n\t\"globalInherits\": [ FQDN1, FQDN2... ], // inherits + inherits of parents, recursively\n\t\"type\": \"class\",\n\t\"packageName\": \"packagename\",\n\t\"packageVersion\": \"version\",\n\t\"phpDoc\": \"doc class\",\n\t\"refresh\": bool // Set to true to force refresh\n}\n```\n\n```\nindex on: packageName + packageVersion\nindex on: name\nindex on: inherits\nindex on: globalInherits\n```\n\nMongoDB package collection:\n\n```js\n{\n\tpackageName: \"\"\n\tversion: \"\"\n\ttype: \"\"\n\treleaseDate: date\n\tdownloads: int\n\tfavers: int\n}\n```\n\nPackanalyst uses Grunt\n-------------------------\nHere is the documentation : [Grunt documentation](http://gruntjs.com/)\n\nQuick use :\n\n1. First install NodeJS and add it to your PATH\n2. Go to `src/views`, here are your `Gruntfile.js` \u0026 `package.json`. Download your dependencies by using command : `npm install`\n3. Now you can use grunt by using `grunt` or `grunt dev`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecodingmachine%2Fpackanalyst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecodingmachine%2Fpackanalyst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecodingmachine%2Fpackanalyst/lists"}