Skip to content

Commit 77926d6

Browse files
committed
[DOCS] Add quick start chapter
1 parent 929f541 commit 77926d6

28 files changed

+483
-0
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
11.6 KB
Loading
23.9 KB
Loading
14.5 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading

Documentation/QuickStart/Index.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../Includes.txt
7+
8+
9+
========================
10+
Quick Start from Scratch
11+
========================
12+
13+
This guide explains to setup your new TYPO3 project with Bootstrap Package and a
14+
Sitepackage from scratch with the help of DDEV Local on your local computer.
15+
Once you have finished you can deploy it to a hoster of your choice.
16+
17+
18+
System Requirements
19+
===================
20+
21+
Make sure you have the following components installed before you continue:
22+
23+
* `DDEV Local and Docker <https://ddev.readthedocs.io/en/stable/>`_
24+
* `Git <https://git-scm.com/>`_ or similar software configuration management,
25+
Git is required on Windows to successfuly run DDEV and used as reference in
26+
this guide
27+
* Editor of your choice like `Visual Studio Code <https://code.visualstudio.com/Download>`_
28+
or `PhpStorm <https://www.jetbrains.com/de-de/phpstorm/download/>`_
29+
30+
Once you have successfuly installed the previous mentioned components your
31+
project will be setup and ready to use within minutes.
32+
33+
34+
Overview
35+
========
36+
37+
.. toctree::
38+
:maxdepth: 5
39+
:titlesonly:
40+
:glob:
41+
42+
Preparation/Index
43+
Sitepackage/Index
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
==================
10+
Configure Composer
11+
==================
12+
13+
14+
TYPO3 Core Extensions
15+
=====================
16+
17+
Now it's time to tell Composer which packages and TYPO3 extensions you like to
18+
install and setup. For a initial setup run the following commands:
19+
20+
.. code-block:: bash
21+
22+
ddev composer create "typo3/cms-base-distribution:^10" --no-install
23+
ddev start
24+
ddev composer config repositories.local path "packages/*"
25+
ddev composer require "my-company/mysitepackage:@dev" --no-update
26+
27+
This will setup your TYPO3 project with a default set of core extensions and
28+
the previously created **Sitepackage**, remember to replace the
29+
**vendor/package**.
30+
31+
32+
TYPO3 Secure Web (optional)
33+
===========================
34+
35+
To increase the security of your project you can simply use the
36+
:composer:`helhum/typo3-secure-web` package.
37+
38+
.. code-block:: bash
39+
40+
ddev composer config extra.typo3/cms.root-dir private
41+
ddev composer config extra.typo3/cms.web-dir public
42+
ddev exec mkdir -p private/typo3conf
43+
ddev exec ln -rs public/typo3conf/AdditionalConfiguration.php private/typo3conf/AdditionalConfiguration.php
44+
ddev composer require "helhum/typo3-secure-web" --no-update
45+
46+
More information can be found at the `TYPO3 Secure Web Github Repository <https://github.com/helhum/typo3-secure-web#readme>`_
47+
48+
49+
Additional TYPO3 (Core) Extensions
50+
==================================
51+
52+
You are free to add more packages, for core extensions head to the
53+
`Composer Helper <https://get.typo3.org/misc/composer/helper>`_ and select the
54+
desired packages, extensions can be found at the
55+
`TYPO3 Extension Repository <https://extensions.typo3.org/>`_. Make sure you
56+
always add the :composer:`--no-update` option to avoid version conflicts
57+
later.
58+
59+
60+
Install the Packages
61+
====================
62+
63+
Once you have finished adding more packages run the following command to start
64+
the installation process:
65+
66+
.. code-block:: bash
67+
68+
ddev composer install
69+
70+
Your project is now installed and ready to setup.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
====================
10+
Configure DDEV Local
11+
====================
12+
13+
Head to your newly created project folder with your favorite shell or the
14+
integrated shell of your editor and run the following command to setup DDEV:
15+
16+
.. code-block:: bash
17+
18+
ddev config --project-type=typo3 --docroot=public --create-docroot=true
19+
20+
DDEV Local is now setup and ready to use.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
==============================================
10+
Initialize the local Git Repository (optional)
11+
==============================================
12+
13+
It is recommended you manage your project with version control system like
14+
**Git** but there is no restriction, you can use your favorite one. This guide
15+
will use **Git** in the examples.
16+
17+
.. code-block:: bash
18+
19+
git init
20+
21+
Your local repository is now setup and ready to use. Please head to the
22+
`Git documentation <https://git-scm.com/doc>`_ to learn how to use **Git** for
23+
your daily work.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
===========
10+
Preparation
11+
===========
12+
13+
Before you can start working on your new project some preparation steps are
14+
required.
15+
16+
17+
Overview
18+
========
19+
20+
.. toctree::
21+
:maxdepth: 5
22+
:titlesonly:
23+
:glob:
24+
25+
ProjectFolder
26+
Sitepackage
27+
Ddev
28+
Composer
29+
InstallWizard
30+
Git
31+
Template
32+
Page
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
===========
10+
Setup TYPO3
11+
===========
12+
13+
In this step your new TYPO3 instance will be setup with a initial
14+
configuration. To gain access to the **TYPO3 Install Wizard** you need to
15+
create the file :file:`FIRST_INSTALL` in the web server root directory:
16+
17+
.. code-block:: bash
18+
19+
ddev exec touch public/FIRST_INSTALL
20+
ddev launch
21+
22+
The last command will open the browser pointing to the **TYPO3 Install Wizard**
23+
which is used for the initial setup of your project. Some steps are skipped
24+
because various configurations like database credentials are already provided
25+
by DDEV and you don't have to care about.
26+
27+
28+
Step 1
29+
======
30+
31+
.. figure:: ../Images/Setup/Step1.png
32+
:width: 500px
33+
:alt: TYPO3 Install Wizard Step 1
34+
:class: with-border
35+
36+
Just click :button:`No problems detected, continue with installation` to
37+
continue with the next step.
38+
39+
40+
Step 2
41+
======
42+
43+
.. figure:: ../Images/Setup/Step4.png
44+
:width: 500px
45+
:alt: TYPO3 Install Wizard Step 4
46+
:class: with-border
47+
48+
Fill the form with the desired credentials for your administrative user and
49+
click :button:`Continue` to head to the final step.
50+
51+
52+
Step 3
53+
======
54+
55+
.. figure:: ../Images/Setup/Step5.png
56+
:width: 500px
57+
:alt: TYPO3 Install Wizard Step 5
58+
:class: with-border
59+
60+
Select :button:`Create empty starting page` and click
61+
:button:`Open the TYPO3 Backend` to be redirected to the backend login page.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
====================
10+
Provide some Content
11+
====================
12+
13+
On the left side choose the **Page module** and in the **page tree** click the
14+
page **Home**.
15+
16+
.. figure:: ../Images/Backend/PageModule.png
17+
:width: 800px
18+
:alt: TYPO3 Page Module
19+
:class: with-shadow
20+
21+
Add a new content element by clicking :button:`+ Content`.
22+
23+
.. figure:: ../Images/Page/ButtonAddContent.png
24+
:alt: Add Content
25+
:class: with-border
26+
27+
Fill some content into the field **Header** and **Text**.
28+
29+
.. figure:: ../Images/Page/RegularTextElement.png
30+
:width: 800px
31+
:alt: Create new Page Content
32+
:class: with-border
33+
34+
On the top click :button:`Save` and :button:`Preview`.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
=======================
10+
Create a Project Folder
11+
=======================
12+
13+
Create a project folder for your new project. This is usualy done in your user
14+
home directory or a sub folder but every place is possible. This guide will
15+
use :file:`typo3-quick-start` as project folder.
16+
17+
In your project folder create a folder :file:`packages`. This folder will be
18+
used as local path repository for project specific extensions and packages
19+
like the **Sitepackage** we will create in the next step.
20+
21+
.. code-block:: bash
22+
23+
mkdir typo3-quick-start
24+
cd typo3-quick-start
25+
mkdir packages
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. ==================================================
2+
.. FOR YOUR INFORMATION
3+
.. --------------------------------------------------
4+
.. -*- coding: utf-8 -*- with BOM.
5+
6+
.. include:: ../../Includes.txt
7+
8+
9+
====================
10+
Create a Sitepackage
11+
====================
12+
13+
Go to the `Sitepackage Builder <https://www.sitepackagebuilder.com/new/>`_
14+
and create your personal **Sitepackage**.
15+
16+
Make sure you select the correct **TYPO3 Version** and **Base Package**, you
17+
can relay your **Sitepackage** on the TYPO3 extension **Bootstrap Package** or
18+
on pure core functionality by selecting **Fluid Styled Content**.
19+
20+
Remeber the **Composer name** of your **Sitepackage** shown after the
21+
creation, you will need it later again, this guide will use the
22+
**Sitepackage name** :composer:`my-company/mysitepackage`.
23+
24+
Save the generated **Sitepackage** to the :file:`packages` folder and extract
25+
it into a sub folder, usualy the name of the downloaded ZIP file. Do not
26+
extract the **Sitepackage** directly into the :file:`packages` folder. This
27+
guide will use the folder name :file:`mysitepackage`.

0 commit comments

Comments
 (0)