Using the littled lib Library in PHP Projects

From Littledamien Wiki
Revision as of 12:25, 7 October 2018 by Video8 (talk | contribs) (→‎Installing composer)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Using composer

Add a composer.json file in the root of the PHP web project and configure it to fetch the littled_lib library from from GitHub.

{
  "require": {
    "php": ">=5.6.0",
    "ext-curl": "*",
    "dbarchowsky/littled": "dev-develop"
  },
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/dbarchowsky/littled_lib.git"
    }
  ]
}

Installing composer

Download and install composer.

Install the libraries specified in composer.json.

$ php composer.phar install

Add the --no-dev option to skip over installing development dependencies:

$ php composer.phar install --no-dev

Making modifications on the library

Make sure to work on the develop branch of the repo.

$ git co develop
$ git pull origin develop
$ git push origin develop

composer.json is configured to look at that branch for updates. Any updates committed to master will be ignored.

Downloading updates

From the directory containing the composer.json and composer.phar files:

$ php composer.phar update

Deployment

Copy composer.json to the staging/production server. The first time composer is run it will prompt for a token from GitHub. Use the link it provides to generate the token on GitHub, copy the token and paste it into the composer prompt to continue with the installation of the libraries. (The GitHub token is for the littled_lib hosted on GitHub, not for composer itself.)

See also