diff --git a/README.md b/README.md index d7d43cd..d7d091f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Skeleton Monarc Project ======================= *Disclaimer: This is a work in progress and software is still in alpha stage.* - + Introduction ------------ Skeleton Monarc Project. @@ -33,6 +33,7 @@ Alternately, clone the repository and manually invoke `composer` using the shipp (The `self-update` directive is to ensure you have an up-to-date `composer.phar` available.) +![Arbo](public/img/arbo1.png "Arbo") Databases --------- @@ -44,10 +45,20 @@ Create 2 databases: Change Sql Mode in my.cnf: sql-mode = MYSQL40 - - + +There is 2 databases: +* monarc_common contain models and data create by smile. +* monarc_master contain all user and authentication information Symbolics links --------------- + +The project is splited on 2 parts : +* an Api in charge of retrieve data +* an interface to display data + +The Api is not direct modules of the project but libraries. +You must create modules with symbolics link to libraries + Create 2 symbolics links at project root: mkdir module @@ -157,8 +168,8 @@ Play script (mandatory from the root of the project)(pull and migrations): This shell script use others shell script. May be you node to change rights of these others files -Create Initial User -------------------- +Create Initial User and Client +------------------------------ Modify email and password (firstname or lastname) of first user in /module/MonarcFO/migrations/seeds/adminUserInit.php @@ -167,6 +178,12 @@ If you have a mail server, you can keep default password and click on "Password Create first user: php ./vendor/robmorgan/phinx/bin/phinx seed:run -c ./module/MonarcBO/migrations/phinx.php + +Data Model +---------- + +monarc_common +![monarc_common](public/img/model-common.png "monarc_common") License ------- @@ -174,3 +191,4 @@ License This software is licensed under [GNU Affero General Public License version 3](http://www.gnu.org/licenses/agpl-3.0.html) Copyright (C) 2016-2017 SMILE gie securitymadein.lu + diff --git a/public/img/arbo1.png b/public/img/arbo1.png new file mode 100644 index 0000000..a3136c4 Binary files /dev/null and b/public/img/arbo1.png differ diff --git a/public/img/arbo2.png b/public/img/arbo2.png new file mode 100644 index 0000000..60eef46 Binary files /dev/null and b/public/img/arbo2.png differ diff --git a/public/img/arbo3.png b/public/img/arbo3.png new file mode 100644 index 0000000..785853e Binary files /dev/null and b/public/img/arbo3.png differ diff --git a/public/img/model-common.png b/public/img/model-common.png new file mode 100644 index 0000000..6d868b6 Binary files /dev/null and b/public/img/model-common.png differ