Merge pull request #23 from OpenConext/feature/update-documentation

Update documentation with latest changes

Author: pablothedude

.env.dist

@@ -7,3 +7,4 @@ APP_SECRET=secret
 # APP_OPAQUE_ID=
 # APP_READID_SERVER_FQDN=
 # APP_WEBHOOK_TOKEN=
+# APP_ATTRIBUTES_MAPPING='{}'

README.md

@@ -31,20 +31,24 @@ Install
 1. Edit the `.env` file with the editor of your choice and: 
     1. Update the `APP_SECRET` to a value of your liking. See [Symfony docs](https://symfony.com/doc/current/reference/configuration/framework.html#secret) for more details about this secret. 
     1. Set the `APP_ENV` to 'dev'
+    1. Set the `APP_ATTRIBUTES_MAPPING` with a json key value pair:
+
+       ```'{"readIdAttribute1":"samlAttribute1", "readIdAttribute1":"samlAttribute1"}'```
 
 **Copy the parameters.yaml**
 
 `$ cp config/packages/parameters.yaml.dist config/packages/parameters.yaml`
 
 **Bring up Docker**
 
+The scrip below will also install the required Yarn and Composer development dependencies and finally build the Encore web assets.
 ```
 $ ./support/docker/init.sh
 ```
 
-If everything goes as intended, you can develop in the virtual machine.
+If everything goes as intended, you can develop in the container.
 
-The machine should be available at: [127.43.33.34:443](https://127.43.33.34:443). Feel free to add a `hosts` file entry,
+The container should be available at: [127.43.33.34:443](https://127.43.33.34:443). Feel free to add a `hosts` file entry,
 I used: 
 
 [readid.stepup.example.com](https://readid.stepup.example.com)
@@ -99,6 +103,5 @@ Please read: https://github.com/OpenConext/Stepup-Deploy/wiki/Release-Management
 Other resources
 ======================
 
- - [Developer documentation](docs/index.md)
  - [Issue tracker](https://www.pivotaltracker.com/n/projects/1163646)
  - [License](LICENSE)

support/docker/init.sh

@@ -5,3 +5,14 @@ gid=$(id -g)
 printf "UID=${uid}\nGID=${gid}\nCOMPOSE_PROJECT_NAME=readid" > .env
 
 docker-compose up -d
+
+# Install backend dependencies
+docker-compose exec -T php-fpm.readid.stepup.example.com bash -c '
+  composer install -n
+'
+
+# Install frontend dependencies
+docker-compose exec -T php-fpm.readid.stepup.example.com bash -c '
+  yarn install --frozen-lockfile
+  yarn dev
+'