Commit 07f51b1c authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Doc

parent 1a71d2ee
Loading
Loading
Loading
Loading
Loading
+49 −4
Changes for README.md: 49 added lines, 4 removed lines.
Original line number Diff line number Diff line
# Squelette d'application Unicaen

Ce squelette d'application constitue un socle minimal pour entamer rapidement le développement d'une nouvelle 
application à la mode "Unicaen".

## Build et lancement du container Docker

    $ docker-compose up --build
## Création d'une nouvelle appli à partir du squelette

## Installation des dépendances PHP :
Ce qui suit est un exemple pour une nouvelle appli PHP 7.3 dans le répertoire `./newapp`.

### Création des sources de l'application

```bash
APP_DIR=newapp
PHP_VERSION=7.3
docker run \
--rm \
-v $PWD:/app \
-w /app unicaen-dev-php${PHP_VERSION}-apache \
composer create-project --repository https://gest.unicaen.fr/packagist unicaen/skeleton-application ${APP_DIR}
```

*NB : l'image Docker `unicaen-dev-php${PHP_VERSION}-apache` est utilisée ici pour lancer `composer` dans
un environnement PHP dont on maîtrise la version. Le nécessaire pour obtenir et construire cette image se trouve 
[ici](https://git.unicaen.fr/open-source/docker/unicaen-image).*

### Mise à jour des bibliothèques PHP

```bash
cd ${APP_DIR}
docker run --rm -v $PWD:/app -w /app unicaen-dev-php${PHP_VERSION}-apache composer update
```

### Création du dépôt git

```bash
cd ${APP_DIR}
git init
git add .
git commit -m "Squelette de l'application"
git push --set-upstream git@git.unicaen.fr:dsi/${APP_DIR}.git master
```

*NB : la création du dépôt git de cette façon n'est possible que si vous disposez des droits suffisants dans le 
namespace gitlab spécifié.*


## Construction et lancement du container Docker

```bash
docker-compose up --build
```

    $ docker-compose run --rm skeleton-application composer install --no-suggest

## Module Demo

@@ -28,6 +71,7 @@ NB :
  se trouvent dans le répertoire `./docker/db` de l'appli et sont fournis au container grâce au montage 
  `./docker/db/:/docker-entrypoint-initdb.d/`. 


## Configuration du projet

- Renommez `config/autoload/local.php.dist` en `local.php` :
@@ -49,6 +93,7 @@ cp vendor/unicaen/auth/config/unicaen-auth.local.php.dist config/autoload/unica
  - [unicaen/app](https://git.unicaen.fr/lib/unicaen/app)
  - [unicaen/auth](https://git.unicaen.fr/lib/unicaen/auth)


## Test de l'application 

Théoriquement, l'application devrait être accessible à l'adresse [https://localhost:8443](https://localhost:8443).