2017 © Pedro Peláez
 

application packages

Packages extends Composer Satis with a management interface and integrations for GitLab and GitHub

image

terramar/packages

Packages extends Composer Satis with a management interface and integrations for GitLab and GitHub

  • Monday, July 9, 2018
  • by tyler-sommer
  • Repository
  • 12 Watchers
  • 119 Stars
  • 12 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 42 Forks
  • 23 Open issues
  • 37 Versions
  • 33 % Grown

The README.md

Packages

Source code repository management made simple., (*1)

Build Status, (*2)

Packages is a PHP 5.6 and 7.x application providing an interface and tools for maintaining a private Composer repository. Packages extends Satis, adding a web frontend and useful management functionality like GitHub and GitLab integration., (*3)

Packages automatically registers GitLab, GitHub, and Bitbucket project webhooks to keep Satis up to date every time you push code. Packages also features a web management interface that allows for easy management of exposed packages and configured source control repositories., (*4)

Packages version 3 works on a plugin based system based around source code repositories. Packages can trigger, with each code push, many automated tasks like documentation generation or code analysis. The simple event-based architecture allows easy creation of new automation tasks., (*5)

View the docs online., (*6)

Installation

Requirements: * PHP 5.6 or later * Composer * Some database platform supported by Doctrine 2 (sqlite works great!) * Redis, (*7)

Download the latest release, or clone the repository., (*8)

git clone git@github.com:terramar-labs/packages.git

Install dependencies

Switch to the project root directory and run composer install., (*9)

cd packages
composer install

Edit configuration

Copy config.yml.dist to config.yml and edit as appropriate., (*10)

cp config.yml.dist config.yml
vi config.yml

Generate the database schema

Packages uses Doctrine ORM to auto-generate the database schema for your configured platform., (*11)

bin/console orm:schema-tool:create

Running the application

Start PHP's built-in webserver to run the Packages web application with minimal effort., (*12)

# Visit http://localhost:8080 to see the landing page.
php -S localhost:8080 -t web

Start a Resque worker

For fully-automatic integration with GitHub, GitLab, and your Satis repository, you must always have at least one Resque worker running., (*13)

bin/console resque:worker:start

For more information on Resque workers, check the dedicated section., (*14)

Using the application

Read the usage and design documentation for an overview of Packages functionality., (*15)

Development/debug mode

Visit index_dev.php in your browser to view the site with the dev environment configuration. In this env, views and the service container are not cached, so changes made are immediately visible., (*16)

Customizing

Check out the Contributing Guide for the recommended way to set up your development environment., (*17)

Some tips:, (*18)

  • Views are written using Twig and stored in views/.
    • Views are cached in prod env; use http://localhost:8080/index_dev.php to develop.
    • All pages inherit from views/base.html.twig, except for
    • Public landing page views inherit from views/Default/base.html.twig.
  • Composer Components are used to manage front-end dependencies. The respective web/images/, web/js/bootstrap.min.js, and such are symlinks pointing to the real files installed by Composer in vendor/.
  • Check the documentation for additional information.

Docker support

Packages comes with an example docker-compose.yml that starts an nginx container and a Redis container, ready to get up and running quickly., (*19)

Visit the documentation to get started., (*20)

Troubleshooting

  1. index_dev.php contains a non-localhost block, comment it out when using Docker.
  2. Manage Resque and Satis using the bin/console command-line utility.
    • Build the Satis packages.json file with the satis:build command. bash bin/console satis:build
    • View queued Resque jobs in Redis with the resque:queue:list command. bash bin/console resque:queue:list
    • View active Resque workers with the resque:worker:list command. bash bin/console resque:worker:list
    • Start a Resque worker with resque:worker:start. bash bin/console resque:worker:start
  3. Check the Resque logs to see if Resque is working properly. bash tail -f logs/resque.log

The Versions

19/02 2014
19/02 2014
01/08 2013

1.2.0

1.2.0.0

Terramar Labs Repository. 'Fork' of composer/satis with some added functionality

  Sources   Download

The Requires

 

21/03 2013

1.1.0

1.1.0.0

Terramar Labs Repository. 'Fork' of composer/satis with some added functionality

  Sources   Download

The Requires

 

21/03 2013

1.0.0

1.0.0.0

Terramar Labs Repository. 'Fork' of composer/satis

  Sources   Download

The Requires