{"id":15287428,"url":"https://github.com/brookinsconsulting/bcgithubstarsbundle","last_synced_at":"2026-01-27T12:03:34.580Z","repository":{"id":62497449,"uuid":"83643860","full_name":"brookinsconsulting/BcGitHubStarsBundle","owner":"brookinsconsulting","description":"BC GitHub Stars Bundle for Symfony 3. Provides a basic solution to import and display GitHub repository data with the most stars. Great for developers seeking to play with GithHub ReST API","archived":false,"fork":false,"pushed_at":"2017-03-07T22:04:33.000Z","size":34,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T02:48:30.026Z","etag":null,"topics":["bundle","github","import","php","rest-api","symfony","symfony-bundle"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brookinsconsulting.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-02T06:39:45.000Z","updated_at":"2017-03-02T07:21:43.000Z","dependencies_parsed_at":"2022-11-02T11:33:15.687Z","dependency_job_id":null,"html_url":"https://github.com/brookinsconsulting/BcGitHubStarsBundle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brookinsconsulting%2FBcGitHubStarsBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brookinsconsulting%2FBcGitHubStarsBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brookinsconsulting%2FBcGitHubStarsBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brookinsconsulting%2FBcGitHubStarsBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brookinsconsulting","download_url":"https://codeload.github.com/brookinsconsulting/BcGitHubStarsBundle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245200680,"owners_count":20576673,"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":["bundle","github","import","php","rest-api","symfony","symfony-bundle"],"created_at":"2024-09-30T15:28:07.883Z","updated_at":"2026-01-27T12:03:29.542Z","avatar_url":"https://github.com/brookinsconsulting.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"BC GitHub Stars\n===============\n\nThis bundle implements a solution to provide Symfony commands to search and import an GitHub repository data and populate a local database repository.\n\n\nVersion\n=======\n\n* The current version of BC GitHub Stars is 0.1.4\n\n* Last Major update: February 24, 2017\n\n\nCopyright\n=========\n\n* BC GitHub Stars is copyright 1999 - 2017 Brookins Consulting\n\n* See: [COPYRIGHT.md](COPYRIGHT.md) for more information on the terms of the copyright and license\n\n\nLicense\n=======\n\nBc GitHub Stars is licensed under the GNU General Public License.\n\nThe complete license agreement is included in the [LICENSE](LICENSE) file.\n\nBc GitHub Stars is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 2 of the License or at your\noption a later version.\n\nBc GitHub Stars is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nThe GNU GPL gives you the right to use, modify and redistribute\nBc GitHub Stars under certain conditions. The GNU GPL license\nis distributed with the software, see the file [LICENSE](LICENSE).\n\nIt is also available at [http://www.gnu.org/licenses/gpl.txt](http://www.gnu.org/licenses/gpl.txt)\n\nYou should have received a copy of the GNU General Public License\nalong with Bc GitHub Stars in in the [LICENSE](LICENSE) file.  \n\nIf not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).\n\nUsing Bc GitHub Stars under the terms of the GNU GPL is free (as in freedom).\n\nFor more information or questions please contact: license@brookinsconsulting.com\n\n\nRequirements\n============\n\nThe following requirements exists for using BC GitHub Stars bundle:\n\n\n### Symfony version\n\n* Make sure you use Symfony version 2.8+ (required) or higher.\n\n* Designed and tested with Symfony 3.2.x\n\n\n### PHP version\n\n* Make sure you have PHP 7.1 or higher.\n\n\nFeatures\n========\n\n### Commands\n\nThis solution provides the following symfony commands\n\n* Command: `bc:gs:import`\n\n### Services\n\n* Services to assist in the search, import and update of github repositories\n\n    * GitHubStars\n    * GitHubStarsComand\n    * GitHubStarsController\n    * GitHubRepositoryModel\n\n### Dependencies\n\n* This solution does not depend on eZ Platform in any way\n* This solution depends on symfony/symfony\n* This solution depends on doctrine/orm and doctrine/doctrine-bundle\n* This solution depends on knpLabs/php-github-api\n* This solution depends on php-http/guzzle6-adapter\n* This solution depends on jms/di-extra-bundle\n* This solution depends on brookinsconsulting/bcknockoutjsbundle\n* This solution depends on brookinsconsulting/github-api-bundle\n* This solution depends on symfony/assetic-bundle\n* This solution depends on braincrafted/bootstrap-bundle\n* This solution depends on twbs/bootstrap\n* This solution depends on jquery/jquery\n* This solution depends on knplabs/knp-paginator-bundle\n* This solution depends on knplabs/knp-menu-bundle\n\nThese dependencies are documented in greater detail within the bundle's composer.json file\n\nUse case requirements\n=====================\n\nThis solution was created to provide for a simple solution to importing and displaying github php repositories with a variable criteria of stars\n\n\nUse case documentation\n======================\n\nhttps://developer.github.com/v3/search/\nhttps://developer.github.com/v3/search/#search-repositories\n\n\nInstallation\n============\n\n### Bundle Installation via Composer\n\nRun the following command from your project root to install the bundle:\n\n    bash$ composer require brookinsconsulting/bcgithubstarsbundle dev-master;\n\n\n### Bundle Activation\n\nWithin file `app/AppKernel.php` method `registerBundles` add the following into the `$bundles = array(` variable definition.\n\n    // Brookins Consulting : BcGitHubStarsBundle Requirements\n    new Maxikg\\GithubApiBundle\\GithubApiBundle(),\n    new JMS\\DiExtraBundle\\JMSDiExtraBundle($this),\n    new JMS\\AopBundle\\JMSAopBundle(),\n    new BrookinsConsulting\\BcKnockoutJSBundle\\BcKnockoutJSBundle(),\n    new Symfony\\Bundle\\AsseticBundle\\AsseticBundle(),\n    new Knp\\Bundle\\PaginatorBundle\\KnpPaginatorBundle(),\n    new Knp\\Bundle\\MenuBundle\\KnpMenuBundle(),\n    new Braincrafted\\Bundle\\BootstrapBundle\\BraincraftedBootstrapBundle(),\n    new BrookinsConsulting\\BcGitHubStarsBundle\\BcGitHubStarsBundle()\n\n\n### Clear the caches\n\nClear Symfony caches (Required).\n\n    php bin/console cache:clear;\n\n### Create Database\n\n    php bin/console doctrine:database:create;\n\n### Create Database Schema\n\n    php bin/console doctrine:schema:create;\n\n### Route Installation\n\nEdit your ```app/config/routing.yml``` file and add the following code to import this bundle's routes\n\n    app_githubstars:\n        resource: \"@BcGitHubStarsBundle/Resources/config/routing.yml\"\n\n### Asset Installation\n\n    php bin/console assets:install web --symlink --relative\n\n### Assetic Installation\n\n    php bin/console assetic:dump --env=prod\n\n\nParameter Customization\n===================================\n\n## Supported Parameters\n\nNote: Currently no parameters are used or required at this time. The following exists for future expansion and refactoring.\n\nPlease review `Resources/config/githubstars.yml` and `Resources/config/services.yml` for the default parameters supported.\n\n\nUsage\n=====\n\nThe solution is configured to work virtually by default once properly installed.\n    \n### Running the import command\n\nTo import the repository data from GitHub run the following command and you will be prompted for required arguments\n\n    php -d memory_limit=-1 bin/console bc:gs:import;\n\n#### Running the create command with shell arguments\n\nFor repeated usage of the same input you can run the script more quickly using shell arguments. Simply run\n\n    php -d memory_limit=-1 bin/console bc:gs:import -v --token=\u003cgithub-token-string\u003e --starsQuery=\"\u003e500\" --iterationStore --update\n\n#### starsQuery Shell Arguement Input Syntax / Format\n\nThe starsQuery shell argument input format / syntax mirrors the github reset api syntax. Learn more about this syntax from the available github documentation: [https://help.github.com/articles/searching-repositories/#search-based-on-the-number-of-stars-a-repository-has](https://help.github.com/articles/searching-repositories/#search-based-on-the-number-of-stars-a-repository-has) and [https://help.github.com/articles/search-syntax/](https://help.github.com/articles/search-syntax/).\n\n#### iterationStore Shell Arguement\n\nThis argument while optional greatly increases the speed in which records are populated into the database and is recommended for queries which larger result sets. This ensures if the command exits for any reason manual or otherwise at least some data is stored before it exits.\n\n#### update Shell Arguement\n\nThis argement is optional and ensures that existing local database records are updated durring the process. This is helpful when running the command more than once and ensures that the repository meta data including the lastPushDate field is updated.\n\n\nUsage : Website UI\n=====\n\nThe solution is configured to work virtually by default once properly installed.\n    \n### Views available\n\n* http://localhost/\n* http://localhost/bcgithubstars/about\n* http://localhost/repository/list\n* http://localhost/repository/1\n\nTo use the available views simply use your web browser to navigate to them.\n\n\nNotice\n======\n\nThe tools provided by this bundle are currently very similar to the tools provided by GitHub.com\n\n* https://github.com/trending/php\n\n* https://github.com/search?o=desc\u0026q=language%3APHP+stars%3A%3E%3D50\u0026s=stars\u0026type=Repositories\u0026utf8=%E2%9C%93\n\n\nTesting\n=====\n\nThe solution is configured to work once properly installed and configured.\n\nNote: At the time of writing xss testing has not been implemented nor proper unit testing.\n\n\nTroubleshooting\n===============\n\n### Read the FAQ\n\nSome problems are more common than others. The most common ones are listed in the the [Resources/doc/FAQ.md](Resources/doc/FAQ.md)\n\n\n### Support\n\nIf you have find any problems not handled by this document or the FAQ you can contact Brookins Consulting through the support system: [http://brookinsconsulting.com/contact](http://brookinsconsulting.com/contact)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrookinsconsulting%2Fbcgithubstarsbundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrookinsconsulting%2Fbcgithubstarsbundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrookinsconsulting%2Fbcgithubstarsbundle/lists"}