MonarcAppFO/README.md

176 lines
4.6 KiB
Markdown
Raw Normal View History

2016-04-12 14:39:18 +02:00
Skeleton Monarc Project
=======================
Introduction
------------
Skeleton Monarc Project.
Installation
------------
2017-01-31 10:45:04 +01:00
PHP & MySQL
-----------
2017-02-01 11:09:55 +01:00
Install PHP (version 7.0 recommended) with Apache (or Nginx) with extensions : xml, mbstring, mysql, zip, unzip, mcrypt, intl, imagick (extension php)
For Apache add mods : rewrite, ssl (a2enmod)
2017-01-31 10:45:04 +01:00
Install MySQL (version 5.7 recommended) or MariaDb equivalent
2016-04-12 14:39:18 +02:00
Using Composer (recommended)
----------------------------
Alternately, clone the repository and manually invoke `composer` using the shipped
`composer.phar`:
cd my/project/dir
2017-02-03 16:11:38 +01:00
git clone ssh://github.com/CASES-LU/MonarcAppFO.git ./monarc
2016-04-12 17:40:50 +02:00
cd monarc
2016-04-12 14:39:18 +02:00
php composer.phar self-update
2017-02-01 11:09:55 +01:00
php composer.phar install -o (modifier le package.json deux errreurs passer en dev-beta le core et il y a un / en trop pour zm-core)
2016-04-12 14:39:18 +02:00
(The `self-update` directive is to ensure you have an up-to-date `composer.phar`
available.)
2017-02-03 16:11:38 +01:00
![Arbo](public/img/arbo1.png "Arbo")
2017-01-31 10:45:04 +01:00
Databases
---------
Create 2 databases:
CREATE DATABASE monarc_cli;
CREATE DATABASE monarc_common;
2017-02-01 16:40:23 +01:00
Change Sql Mode in my.cnf:
2017-02-01 11:09:55 +01:00
2017-02-01 16:40:23 +01:00
sql-mode = MYSQL40
2017-02-03 16:11:38 +01:00
2017-01-31 10:45:04 +01:00
Symbolics links
---------------
Create 2 symbolics links at project root:
mkdir module
cd module
ln -s ./../vendor/monarc/core MonarcCore;
ln -s ./../vendor/monarc/frontoffice MonarcFO;
2017-02-03 16:11:38 +01:00
![Arbo](public/img/arbo2.png "Arbo")
2017-02-03 16:11:38 +01:00
Interfaces
----------
Repository for angular at project root:
mkdir node_modules
cd node_modules
git clone https://github.com/CASES-LU/ng-client.git ng_client
git clone https://github.com/CASES-LU/ng-anr.git ng_anr
![Arbo](public/img/arbo3.png "Arbo")
2017-01-31 10:45:04 +01:00
2016-04-12 14:39:18 +02:00
Web Server Setup
----------------
### PHP CLI Server
The simplest way to get started if you are using PHP 5.4 or above is to start the internal PHP cli-server in the root directory:
php -S 0.0.0.0:8080 -t public/ public/index.php
This will start the cli-server on port 8080, and bind it to all network
interfaces.
**Note: ** The built-in CLI server is *for development only*.
### Apache Setup
To setup apache, setup a virtual host to point to the public/ directory of the
project and you should be ready to go! It should look something like below:
<VirtualHost *:80>
ServerName monarc.localhost
DocumentRoot /path/to/monarc/public
SetEnv APPLICATION_ENV "development"
<Directory /path/to/monarc/public>
DirectoryIndex index.php
AllowOverride All
Order allow,deny
Allow from all
</Directory>
</VirtualHost>
2016-04-12 17:40:50 +02:00
Database connection
-------------------
2017-01-31 10:45:04 +01:00
Create file `config/autoload/local.php`:
2016-04-12 17:40:50 +02:00
return array(
'doctrine' => array(
'connection' => array(
'orm_default' => array(
'params' => array(
'host' => 'host',
'user' => 'user',
'password' => 'password',
2017-01-31 10:45:04 +01:00
'dbname' => 'monarc_common',
),
),
'orm_cli' => array(
'params' => array(
'host' => 'host',
'user' => 'user',
'password' => 'password',
'dbname' => 'monarc_cli',
2016-04-12 17:40:50 +02:00
),
),
),
),
);
2017-01-31 10:45:04 +01:00
Configuration
-------------
Create file configuration
sudo cp /config/autoload/local.php.dist /config/autoload/local.php
Update connexion information to local.php and global.php
Configuration files are stored in cache.
If yours changes have not been considered, empty cache by deleting file in /data/cache
Install Grunt
-------------
sudo apt-get install nodejs
sudo apt-get install npm
sudo npm install -g grunt-cli
Only for linux system:
sudo ln -s /usr/bin/nodejs /usr/bin/node (seulement linux)
Update project
--------------
2017-02-01 11:09:55 +01:00
Play script (mandatory from the root of the project)(pull and migrations):
2017-01-31 10:45:04 +01:00
2017-02-01 11:09:55 +01:00
sudo /bin/bash ./scripts/update-all.sh
2017-01-31 10:45:04 +01:00
This shell script use others shell script. May be you node to change rights of these others files
Create Initial User
-------------------
2017-02-01 11:09:55 +01:00
Modify email and password (firstname or lastname) of first user in /module/MonarcFO/migrations/seeds/adminUserInit.php
If you have a mail server, you can keep default password and click on "Password forgotten ?" after user creation.
2017-01-31 10:45:04 +01:00
Create first user:
php ./vendor/robmorgan/phinx/bin/phinx seed:run -c ./module/MonarcFO/migrations/phinx.php
Data Model
----------
![Model FO](public/img/model-fo.png "modelFO")