Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-07 18:44:08 +00:00
Code Issues Actions Projects Releases Wiki Activity

Merge pull request #3 from jphuart/master

Browse Source 
small changes in install
This commit is contained in:
Julien Fastré 2015-07-21 14:02:45 +02:00
commit 1c7c7217cb
2 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
source/development/installation.rst
View File

@ -13,10 +13,10 @@ Installation for development
Installation for development should let you able to have an access to the source code, upload the code to our CVS (i.e. `git`_), and working with `composer`_.
As Chill is divided into modules, each module has his own repository.
As Chill is divided into bundles (the Symfony name for 'modules'), each bundle has his own repository.
Installation and big picture
-----------------------------
----------------------------
At first, you should install Chill as described in the :ref:`basic-installation` section.
@ -26,8 +26,7 @@ At first, You should add the `--prefer-source` argument when you create project.
.. code-block:: bash
php composer.phar create-project chill-project/standard \
path/to/your/directory --stability=dev --prefer-source
composer create-project chill-project/standard path/to/your/directory --stability=dev --prefer-source
Secondly, if composer ask you the following question : ::
@ -35,7 +34,7 @@ Secondly, if composer ask you the following question : ::
**You should answer `n` (no).**
This will install a project. All downloaded modules will be stored in the `/vendor` directories. In those directories, you will have access to the git commands.
This will install a project. All downloaded bundles will be stored in the `/vendor` directories. In those directories, you will have access to the git commands.
.. code-block:: bash
@ -46,13 +45,13 @@ This will install a project. All downloaded modules will be stored in the `/vend
origin git://github.com/Chill-project/Standard.git (fetch)
origin git@github.com:Chill-project/Standard.git (push)
Deleted and added files after installation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Files cleaning after installation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Composer will deleted unrequired files, and add some of them. This perfectly normal and will appears in your git index. But you should NOT delete those files.
Composer will delete unrequired files, and add some. This is perfectly normal and will appears in your git index.
But you should NOT delete those files.
This should appears :
This is the expected 'git status' result:
.. code-block:: bash
@ -68,7 +67,7 @@ This should appears :
supprimé: app/SymfonyStandard/RootPackageInstallSubscriber.php
modifié: app/check.php
You can ignore the locally using the `git update-index --assume-unchanged` command.
You can ignore the local changes using the `git update-index --assume-unchanged` command.
.. code-block:: bash
@ -80,9 +79,10 @@ You can ignore the locally using the `git update-index --assume-unchanged` comma
Working with your own fork
^^^^^^^^^^^^^^^^^^^^^^^^^^
Ideally, you will work on a fork of the main github repository. To ensure that composer will download the code from **your** repository, you will have to adapt the `composer.json` file accordingly, using your own repository.
Ideally, you will work on a fork of the main github repository.
To ensure that composer will download the code from **your** repository, you will have to adapt the `composer.json` file accordingly, using your own repository.
Add the following lines to your composer.json file if you want to force composer to download from your own repository. This will force to use your own repository for the ChillMain bundle, insert in `composer.json` the following lines :
Add the following lines to your composer.json file if you want to force composer to download from your own repository:
.. code-block:: json
@ -102,7 +102,7 @@ Editing the code and commiting
You may edit code in the `vendor/path/to/the/bundle` directory.
After your edits, you should commit as usually :
Once satisfied with your changes, you should commit as usually :
.. code-block:: bash

33
source/installation/installation.rst
View File

@ -31,7 +31,7 @@ Server requirements
^^^^^^^^^^^^^^^^^^^
* a postgresql database, with the `*unaccent* extension`_ enabled. The minimum version is postgresql 9.4. You can use `the docker image provided <https://registry.hub.docker.com/u/chill/database/>`_. Using the docker image is also a solution for production site. Alternatively you can install a PosgresSql server see :ref:`install-postgres-server`.
* PHP 5.5.
* PHP version >= 5.5. Check that extensions php5-intl and php5-pgsql are installed and that '*date.timezone*' is correctly defined in your php.ini.
* Composer.
* If you run Chill in production mode, you should also install a web server (apache, ngnix, ...) see :ref:`install-production-webserver`. For this basic installation meant for testing and/or development, we will make it simplier using the php built-in server.
@ -90,15 +90,19 @@ The db will start in your terminal. In another terminal, you can check if the do
>>>> CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
>>>> 08bbb62bd5e8 chill/database "/docker-entrypoint. 6 days ago Up 5 hours 0.0.0.0:32768->5432/tcp chill_db
You can start and stop the container it via:
You can start the container it via:
.. code-block:: bash
sudo docker start chill_db
>>>> chill_db
sudo docker stop chill_db
>>>> chill_db
.. note:: The commande to stop the docker container is:
.. code-block:: bash
sudo docker stop chill_db
>>>> chill_db
Installation
@ -149,12 +153,6 @@ Create your Chill project using composer:
composer create-project chill-project/standard path/to/your/directory --stability=dev
You should, now, move your cursor to the new directory
.. code-block:: bash
cd path/to/your/directory
.. note::
Until now, the stability of the project is set to "dev". Do not forget this argument, or composer will fail to download and create the project.
@ -192,6 +190,12 @@ For production, set them all to `false`.
Check your requirements
^^^^^^^^^^^^^^^^^^^^^^^
Move your cursor to the new directory
.. code-block:: bash
cd path/to/your/directory
You should check your installation by running
.. code-block:: bash
@ -218,17 +222,14 @@ SQL queries will be printed into your console.
Populate your database with basic information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once your database schema is ready, you should populate your database with some basic information. Those are provided through scripts and might depends from the bundle you choose to install (see :ref:`install-additional-bundles`)
The main bundle require two scripts to be executed :
Once your database schema is ready, if you want to test the application you have the opportunity to populate your database with some basic data.
Those are provided through a script and might depends from the bundle you choose to install (see :ref:`install-additional-bundles`).
This script has not to be launched for a production server and will erase any existing data. It is meant only for testing the application.
.. code-block:: bash
php app/console doctrine:fixtures:load
Those will populate database, respectively, with basic dummy data, countries (using ISO declaration) and languages (using, also, ISO informations).
Preparing assets
^^^^^^^^^^^^^^^^