Giter Club home page Giter Club logo

skeleton-service's Introduction

Skeleton Service

This project is intented to be a skeleton for PHP based services.

Minimum PHP Version Build Status SensioLabs Insight License

Getting started

$ docker build -t crakmedia/skeleton-service:latest .

$ cp docker-compose.yml.dist docker-compose.yml

$ docker-compose run shell

    $ composer install

$ docker-compose up

Overriding default settings

Should over need to override the default configuratio for any of the services runing within the container, you can add docker volumes to your docker-compose.yml. As an example, say you need to modify the default nginx configuration provided by the base image. In this case you just need to add a new voluming mapping under the volumes section in your docker-compose.yml file:

volumes:
 ... existing mappings ...
 - /path/to/nginx.conf:/etc/nginx/nginx.conf

The following is a list of files/directories added in the base image, which could be overriden:

- /etc/nginx/conf.d
- /etc/nginx/nginx.conf
- /etc/php.ini
- /etc/php-fpm.conf
- /etc/php-fpm.d

Of course you can always use docker volumes to override any file/directory within a running container. See here for more details.

Migrations

Run migrations

$ docker-compose run shell

$ php app/console migrations:migrate

Tests

First, go in your container shell

$ docker-compose run shell

Copy tests/config.yml.dist to tests/config.yml and configure your test database

$ cp tests/config.yml.dist tests/config.yml

Functional tests

$ bin/behat

Generate doc

Install apidoc

$ npm install apidoc -g

Generate doc

$ apidoc -i src/Controller/ -o doc

Launch doc/index.html with your browser.

Monitor your metrics

In order to monitor metrics of application, you should use $app['monitor']. For more information about how to use, see documentation of the client

skeleton-service's People

Contributors

jmaitrehenry avatar

Watchers

Sylvain Witmeyer avatar  avatar James Cloos avatar JnMik avatar Michel Gignac avatar

Forkers

jnmik

skeleton-service's Issues

Update guzzle to guzzle 3

When we run composer update:

guzzle/guzzle suggests installing guzzlehttp/guzzle (Guzzle 5 has moved to a new package name. The package you have installed, Guzzle 3, is deprecated.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.