Skip to content
Snippets Groups Projects
Commit 2e05c9cb authored by damjan's avatar damjan
Browse files

[TASK] Small fixes in readme

parent a150f2a2
No related branches found
No related tags found
No related merge requests found
...@@ -4,7 +4,8 @@ ...@@ -4,7 +4,8 @@
SGalinski.TypoScriptReferenceFrontend is Flow package, so you need first a flow project: SGalinski.TypoScriptReferenceFrontend is Flow package, so you need first a flow project:
Use `composer create-project --dev --keep-vcs typo3/flow-base-distribution ProjectName` 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. You can use any project name you wish. If you already have Flow project, you can skip this step.
## Install ## Install
...@@ -13,17 +14,17 @@ The project can be installed by composer, or downloaded from git: ...@@ -13,17 +14,17 @@ The project can be installed by composer, or downloaded from git:
### A) Install by composer ### A) Install by composer
Change into `ProjectName` directory TODO: Setup composer.json to install from git repository
TODO: Setup composer.json to install from git repository cd ProjectName
composer require ...
Use `composer require ...` and `composer update` to install the package. composer update
### B) Download from git ### B) Download from git
cd Packages/Application cd Packages/Application
git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend
cd typo_script_backend cd typo_script_backend
## Supply the necessary routes ## Supply the necessary routes
...@@ -33,7 +34,7 @@ Edit Routes.yaml of your project (`ProjectName/Configuration/Routes.yaml`) ...@@ -33,7 +34,7 @@ Edit Routes.yaml of your project (`ProjectName/Configuration/Routes.yaml`)
It is important to include SGalinski.TypoScriptReferenceFrontend subRoutes before WMDB.ForgerSubroutes to avoid It is important to include SGalinski.TypoScriptReferenceFrontend subRoutes before WMDB.ForgerSubroutes to avoid
route conflicts. route conflicts.
The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has purpose to avoid the conflict. The prefix `ts` in uriPattern: `ts/<SGalinski.TypoScriptReferenceFrontend>` has purpose to avoid the conflict.
<pre> <pre>
- -
...@@ -66,8 +67,6 @@ The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has ...@@ -66,8 +67,6 @@ The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has
### In empty project Routes.yaml looks like this ### In empty project Routes.yaml looks like this
Uri prefix can be added if needed.
<pre> <pre>
- -
name: 'TypoScriptReferenceFrontend' name: 'TypoScriptReferenceFrontend'
...@@ -90,14 +89,16 @@ Uri prefix can be added if needed. ...@@ -90,14 +89,16 @@ Uri prefix can be added if needed.
package: TYPO3.Flow package: TYPO3.Flow
</pre> </pre>
Uri prefix can be added if needed.
## Configure view ## Configure view
To be able to integrate SGalinski.TypoScriptReferenceFrontend package with other packages 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. (for example to use existing menu from other package), view configuration in main project is needed.
Here is view configuration for integration with WMDB.Forger package. Here is view configuration for integration with `WMDB.Forger` package.
ProjectName/Configuration/Views.yaml: `ProjectName/Configuration/Views.yaml`:
<pre> <pre>
- -
...@@ -119,4 +120,4 @@ All the data which is used by this package is provided by RESTful web service: ...@@ -119,4 +120,4 @@ All the data which is used by this package is provided by RESTful web service:
https://gitlab.sgalinski.de/typo3/TypoScript-Backend https://gitlab.sgalinski.de/typo3/TypoScript-Backend
If the service is not installed, follow it's readme to do so. If the web service is not installed, follow it's readme to do so.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment