-
-
Notifications
You must be signed in to change notification settings - Fork 206
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
929f541
commit 56fd040
Showing
23 changed files
with
556 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../Includes.txt | ||
|
||
|
||
======================== | ||
Quick Start from Scratch | ||
======================== | ||
|
||
This guide explains to setup your new TYPO3 project with Bootstrap Package and a | ||
Sitepackage from scratch with the help of DDEV Local on your local computer. | ||
Once you have finished you can deploy it to a hoster of your choice. | ||
|
||
|
||
System Requirements | ||
=================== | ||
|
||
Make sure you have the following components installed before you continue: | ||
|
||
* `DDEV Local and Docker <https://ddev.readthedocs.io/en/stable/>`_ | ||
* `Git <https://git-scm.com/>`_ or similar software configuration management, | ||
Git is required on Windows to successfuly run DDEV and used as reference in | ||
this guide | ||
* Editor of your choice like `Visual Studio Code <https://code.visualstudio.com/Download>`_ | ||
or `PhpStorm <https://www.jetbrains.com/de-de/phpstorm/download/>`_ | ||
|
||
Once you have successfuly installed the previous mentioned components your | ||
project will be setup and ready to use within minutes. | ||
|
||
|
||
Overview | ||
======== | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:titlesonly: | ||
:glob: | ||
|
||
Preparation/Index | ||
Sitepackage/Index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../Includes.txt | ||
|
||
|
||
===================== | ||
Add Pages and Content | ||
===================== | ||
|
||
|
||
Login to the Backend | ||
==================== | ||
|
||
.. figure:: ../Images/Backend/Login.png | ||
:width: 200px | ||
:alt: TYPO3 Backend Login | ||
:class: with-border | ||
|
||
Enter your choosen credentials here and login to the | ||
TYPO3 backend. | ||
|
||
|
||
The Dashboard | ||
------------- | ||
|
||
.. figure:: ../Images/Backend/Dashboard.png | ||
:width: 800px | ||
:alt: TYPO3 Dashboard | ||
:class: with-shadow | ||
|
||
After the successful login you will be redirected to the TYPO3 Dashboard. | ||
|
||
|
||
Edit the TypoScript Template | ||
============================ | ||
|
||
On the left side choose the **Template module**. | ||
|
||
.. figure:: ../Images/Backend/TemplateModule.png | ||
:width: 800px | ||
:alt: TYPO3 Backend Login | ||
:class: with-shadow | ||
|
||
Here you select the existing template **Main TypoScript Rendering** on the | ||
page **Home**. | ||
|
||
On the top select :button:`Info/Modify` | ||
|
||
.. figure:: ../Images/Template/SelectAction.png | ||
:alt: Select Template Action | ||
:class: with-border | ||
|
||
and click to :button:`Edit the whole template record`. | ||
|
||
.. figure:: ../Images/Template/InfoModify.png | ||
:width: 800px | ||
:alt: Edit Template | ||
:class: with-border | ||
|
||
|
||
General | ||
------- | ||
|
||
On the tab **General** remove the default content of the **Setup** field. You | ||
are free to change here also the **Template Title**. | ||
|
||
.. figure:: ../Images/Template/General.png | ||
:width: 800px | ||
:alt: General Tab | ||
:class: with-border | ||
|
||
|
||
Options | ||
------- | ||
|
||
On the tab **Options** change the settings according to this listing and the | ||
following image: | ||
|
||
* Check **Clear Constants** | ||
* Check **Clear Setup** | ||
* Activate **Rootlevel** | ||
|
||
.. figure:: ../Images/Template/Options.png | ||
:width: 800px | ||
:alt: Options Tab | ||
:class: with-border | ||
|
||
|
||
Includes | ||
-------- | ||
|
||
On the tab **Includes** change the settings according to this listing and the | ||
following image: | ||
|
||
* Remove all **Include static (from extensions)** items | ||
* Add your **Sitepackage** to **Include static (from extensions)** | ||
* For **Static Template Files from TYPO3 Extensions** select | ||
**Include before all static templates if root flag is set** | ||
|
||
.. figure:: ../Images/Template/Includes.png | ||
:width: 800px | ||
:alt: Options Tab | ||
:class: with-border | ||
|
||
|
||
Save and Close the Template | ||
--------------------------- | ||
|
||
On the top click to **Save**: | ||
|
||
.. figure:: ../Images/Template/ButtonSave.png | ||
:alt: Save Button | ||
:class: with-border | ||
|
||
The template is now fully setup and you can close it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../../Includes.txt | ||
|
||
|
||
================== | ||
Configure Composer | ||
================== | ||
|
||
|
||
TYPO3 Core Extensions | ||
===================== | ||
|
||
Now it's time to tell Composer which packages and TYPO3 extensions you like to | ||
install and setup. For a initial setup run the following commands: | ||
|
||
.. code-block:: bash | ||
ddev composer create "typo3/cms-base-distribution:^10" --no-install | ||
ddev start | ||
ddev composer config repositories.local path "packages/*" | ||
ddev composer require "my-company/mysitepackage:@dev" --no-update | ||
This will setup your TYPO3 project with a default set of core extensions and | ||
the previously created **Sitepackage**, remember to replace the | ||
**vendor/package**. | ||
|
||
|
||
TYPO3 Secure Web (optional) | ||
=========================== | ||
|
||
To increase the security of your project you can simply use the | ||
:composer:`helhum/typo3-secure-web` package. | ||
|
||
.. code-block:: bash | ||
ddev composer config extra.typo3/cms.root-dir private | ||
ddev composer config extra.typo3/cms.web-dir public | ||
ddev exec mkdir -p private/typo3conf | ||
ddev exec ln -rs public/typo3conf/AdditionalConfiguration.php private/typo3conf/AdditionalConfiguration.php | ||
ddev composer require "helhum/typo3-secure-web" --no-update | ||
More information can be found at the `TYPO3 Secure Web Github Repository <https://github.com/helhum/typo3-secure-web#readme>`_ | ||
|
||
|
||
Additional TYPO3 (Core) Extensions | ||
================================== | ||
|
||
You are free to add more packages, for core extensions head to the | ||
`Composer Helper <https://get.typo3.org/misc/composer/helper>`_ and select the | ||
desired packages, extensions can be found at the | ||
`TYPO3 Extension Repository <https://extensions.typo3.org/>`_. Make sure you | ||
always add the :composer:`--no-update` option to avoid version conflicts | ||
later. | ||
|
||
|
||
Install the Packages | ||
==================== | ||
|
||
Once you have finished adding more packages run the following command to start | ||
the installation process: | ||
|
||
.. code-block:: bash | ||
ddev composer install | ||
Your project is now installed and ready to setup. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../../Includes.txt | ||
|
||
|
||
==================== | ||
Configure DDEV Local | ||
==================== | ||
|
||
Head to your newly created project folder with your favorite shell or the | ||
integrated shell of your editor and run the following command to setup DDEV: | ||
|
||
.. code-block:: bash | ||
ddev config --project-type=typo3 --docroot=public --create-docroot=true | ||
DDEV Local is now setup and ready to use. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../../Includes.txt | ||
|
||
|
||
============================================== | ||
Initialize the local Git Repository (optional) | ||
============================================== | ||
|
||
[Add introduction]. | ||
|
||
.. code-block:: bash | ||
git init | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../../Includes.txt | ||
|
||
|
||
=========== | ||
Preparation | ||
=========== | ||
|
||
Before you can start working on your new project some preparation steps are | ||
required. | ||
|
||
|
||
Overview | ||
======== | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:titlesonly: | ||
:glob: | ||
|
||
ProjectFolder | ||
Sitepackage | ||
Ddev | ||
Composer | ||
InstallWizard | ||
Git | ||
Template |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../../Includes.txt | ||
|
||
|
||
=========== | ||
Setup TYPO3 | ||
=========== | ||
|
||
In this step your new TYPO3 instance will be setup with a initial | ||
configuration. To gain access to the **TYPO3 Install Wizard** you need to | ||
create the file :file:`FIRST_INSTALL` in the web server root directory: | ||
|
||
.. code-block:: bash | ||
ddev exec touch public/FIRST_INSTALL | ||
ddev launch | ||
The last command will open the browser pointing to the **TYPO3 Install Wizard** | ||
which is used for the initial setup of your project. Some steps are skipped | ||
because various configurations like database credentials are already provided | ||
by DDEV and you don't have to care about. | ||
|
||
|
||
Step 1 | ||
====== | ||
|
||
.. figure:: ../Images/Setup/Step1.png | ||
:width: 500px | ||
:alt: TYPO3 Install Wizard Step 1 | ||
:class: with-border | ||
|
||
Just click :button:`No problems detected, continue with installation` to | ||
continue with the next step. | ||
|
||
|
||
Step 2 | ||
====== | ||
|
||
.. figure:: ../Images/Setup/Step4.png | ||
:width: 500px | ||
:alt: TYPO3 Install Wizard Step 4 | ||
:class: with-border | ||
|
||
Fill the form with the desired credentials for your administrative user and | ||
click :button:`Continue` to head to the final step. | ||
|
||
|
||
Step 3 | ||
====== | ||
|
||
.. figure:: ../Images/Setup/Step5.png | ||
:width: 500px | ||
:alt: TYPO3 Install Wizard Step 5 | ||
:class: with-border | ||
|
||
Select :button:`Create empty starting page` and click | ||
:button:`Open the TYPO3 Backend` to be redirected to the backend login page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
.. ================================================== | ||
.. FOR YOUR INFORMATION | ||
.. -------------------------------------------------- | ||
.. -*- coding: utf-8 -*- with BOM. | ||
.. include:: ../../Includes.txt | ||
|
||
|
||
======================= | ||
Create a Project Folder | ||
======================= | ||
|
||
Create a project folder for your new project. This is usualy done in your user | ||
home directory or a sub folder but every place is possible. This guide will | ||
use :file:`typo3-quick-start` as project folder. | ||
|
||
Create a folder :file:`packages` in your project folder. This folder will be | ||
used as local path repository for project specific extensions and packages | ||
like the **Sitepackage** we will create in the next step. | ||
|
||
.. code-block:: bash | ||
mkdir typo3-quick-start | ||
cd typo3-quick-start | ||
mkdir packages |
Oops, something went wrong.