loveoss/community-platform

This package is abandoned and no longer maintained. No replacement package was suggested.

Community Platform is a PHP framework to make GitHub bots

v0.5 2018-04-05 01:12 UTC

Requires

• php: >=7.1
• ext-mbstring: *
• ext-zip: *
• doctrine/doctrine-bundle: ^1.6
• doctrine/doctrine-cache-bundle: ^1.2
• doctrine/orm: ^2.5
• incenteev/composer-parameter-handler: ^2.0
• knplabs/github-api: ^2.0
• lp-digital/github-event-parser: ~0.8
• php-http/guzzle6-adapter: ^1.0
• sensio/distribution-bundle: ^5.0
• sensio/framework-extra-bundle: ^3.0.2
• symfony/asset: ^3.4
• symfony/console: ^3.4
• symfony/debug-bundle: ^3.4
• symfony/framework-bundle: ^3.4
• symfony/lts: v3
• symfony/monolog-bundle: ^3.1
• symfony/polyfill-apcu: ^1.0
• symfony/security-bundle: ^3.4
• symfony/swiftmailer-bundle: ^3.0
• symfony/templating: ^3.4
• symfony/translation: ^3.4
• symfony/twig-bundle: ^3.4
• symfony/validator: ^3.4
• symfony/web-profiler-bundle: ^3.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.0
• symfony/browser-kit: ^3.4
• symfony/phpunit-bridge: ^3.0

GPL-3.0+

• Mickaël Andrieu

README

Community Platform gives you an easy api and tools to make your own Github bots and tools.

How to install ?

You need to create your own GitHub personal token. After installation and the hosting of your community-platform project, you need to register a webhook to get information from GitHub.

Then, you must configure a Secured GitHub token.

Classic installation

First of all you have to configure your GitHub repository and have a GitHub token.

composer install // and complete the interactive fields asked

Docker installation

First, setup the docker-compose.yml file with a valid GitHub token and a valid Secure token (can be empty).

make start

The Home page is now available at "http://localhost:81/".

How to test ?

./vendor/bin/simple-phpunit
# or (using docker)
make test

To launch tests suite, you only need to setup your own Github token (GH_TOKEN).

Our standards ?

Yeah, mostly the Symfony ones:

./vendor/bin/php-cs-fixer fix # we use the Symfony level + short array notation filter

What can I expect from the Community Platform?

• Comment on a pull request to help a contributor fix his work;
• Extract data from the pull request and look for some terms;
• Manage labels;
• Validate a pull request description;
• Welcome every new contributor;
• Labelize a PR regarding information in description
• Labelize a PR regarding files updated