2017 © Pedro PelĆ”ez
 

project community-platform

Community Platform is a PHP framework to make GitHub bots

image

loveoss/community-platform

Community Platform is a PHP framework to make GitHub bots

  • Thursday, April 5, 2018
  • by mickaelandrieu
  • Repository
  • 1 Watchers
  • 4 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 2 Open issues
  • 7 Versions
  • 0 % Grown

The README.md

Community Platform

Community Platform gives you an easy api and tools to make your own Github bots and tools., (*1)

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., (*2)

Then, you must configure a Secured GitHub token., (*3)

Classic installation

First of all you have to configure your GitHub repository and have a GitHub token., (*4)

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)., (*5)

make start

The Home page is now available at "http://localhost:81/"., (*6)

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)., (*7)

Our standards ?

Yeah, mostly the Symfony ones:, (*8)

./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

The Versions