diff --git a/README.md b/README.md index 86cd13b2549b8a100ae2a5492a9da4bafd1e3070..b516c89a959091202010791cfc2278b1c34f6488 100755 --- a/README.md +++ b/README.md @@ -1,19 +1,17 @@ -SGalinski.TypoScriptReferenceFrontend +# Instalation guide for SGalinski.TypoScriptReferenceFrontend Flow package -## Setup Notes - -### Prerequisite +## Prerequisite SGalinski.TypoScriptReferenceFrontend is Flow package, so you need first a flow project: Use `composer create-project --dev --keep-vcs typo3/flow-base-distribution ProjectName` You can use any project name you wish. If you already have Flow project, you can skip this step. -### Install +## Install The project can be installed by composer, or downloaded from git: -#### A) Install by composer +### A) Install by composer Change into `ProjectName` directory @@ -21,17 +19,17 @@ Change into `ProjectName` directory Use `composer require ...` and `composer update` to install the package. -#### B) Download from git +### B) Download from git cd Packages/Application git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend cd typo_script_backend -### Supply the necessary routes +## Supply the necessary routes Edit Routes.yaml of your project (`ProjectName/Configuration/Routes.yaml`) -#### If you are using WMDB.Forger package in same project +### If you are using WMDB.Forger package in same project It is important to include SGalinski.TypoScriptReferenceFrontend subRoutes before WMDB.ForgerSubroutes to avoid route conflicts. @@ -66,7 +64,7 @@ The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has package: TYPO3.Flow </pre> -#### In empty project Routes.yaml looks like this +### In empty project Routes.yaml looks like this Uri prefix can be added if needed. @@ -92,7 +90,7 @@ Uri prefix can be added if needed. package: TYPO3.Flow </pre> -### Configure view +## Configure view To be able to integrate SGalinski.TypoScriptReferenceFrontend package with other packages (for example to use existing menu from other package), view configuration in main project is needed. @@ -101,13 +99,24 @@ Here is view configuration for integration with WMDB.Forger package. ProjectName/Configuration/Views.yaml: - - - options: - layoutRootPaths: - 'WMDB.Forger/Layouts': 'resource://WMDB.Forger/Private/Layouts' - partialRootPaths: - 'WMDB.Forger/Partials': 'resource://WMDB.Forger/Private/Partials' - 'SGalinski.TypoScriptReferenceFrontend/Partials': 'resource://SGalinski.TypoScriptReferenceFrontend/Private/Partials' - # templateRootPaths: - # 'WMDB.Forger/Templates': 'resource://WMDB.Forger/Private/Templates' - # 'SGalinski.TypoScriptReferenceFrontend/Templates': 'resource://SGalinski.TypoScriptReferenceFrontend/Private/Templates' +<pre> +- + options: + layoutRootPaths: + 'WMDB.Forger/Layouts': 'resource://WMDB.Forger/Private/Layouts' + partialRootPaths: + 'WMDB.Forger/Partials': 'resource://WMDB.Forger/Private/Partials' + 'SGalinski.TypoScriptReferenceFrontend/Partials': 'resource://SGalinski.TypoScriptReferenceFrontend/Private/Partials' +# templateRootPaths: +# 'WMDB.Forger/Templates': 'resource://WMDB.Forger/Private/Templates' +# 'SGalinski.TypoScriptReferenceFrontend/Templates': 'resource://SGalinski.TypoScriptReferenceFrontend/Private/Templates' +</pre> + +## Install backend + +This project is front end part of grater entity. +All the data which is used by this package is provided by RESTful web service: + + https://gitlab.sgalinski.de/typo3/TypoScript-Backend + +If the service is not installed, follow it's readme to do so.