README.md 1.84 KB
Newer Older
Benni Mack's avatar
Benni Mack committed
1
2
3
4
5
6
7
8
9
10
11
# TYPO3 Demo Project

This is the GIT repository for the official demo project of TYPO3. It contains
all source files to build the website for https://demo.typo3.org.

## About the Demo Project

The demo project is a fictitious informational website about apples. It acts as
a example website for people who never worked with TYPO3, and want to play around
with the TYPO3 Administration Interface (= TYPO3 Backend).

12
A special demo login allows creating custom one-time editors without any password.
Benni Mack's avatar
Benni Mack committed
13

14
As soon as one backend user signs in to the TYPO3 Backend, a counter is shown both on the website
Benni Mack's avatar
Benni Mack committed
15
16
17
and on the TYPO3 Backend that within 30 minutes, the TYPO3 installation will be re-set
to the current state.

18
19
20
21
22
23
24
25
26
27
## Local Development

Requirements:

* DDEV, see [Get Started with DDEV](https://www.ddev.com/get-started/)

To set up the TYPO3 Demo Project for local development

1. Download code `git clone ssh://git@gitlab.typo3.org:2222/services/demo.typo3.org/site.git`
2. Install composer packages `ddev composer install`
28
29
30
31
32
33
34
35
3. Build the frontend `ddev composer frontend-builds`
4. Download database/fileadmin: Go to the [Generic Packages](https://gitlab.typo3.org/services/demo.typo3.org/site/-/packages) section in Gitlab, select the "site"-Package and download the latest "demo-data.zip"
5. Extract the downloaded file
6. Copy the `fileadmin` folder to `<document root>web/fileadmin`
7. Import database: `ddev import-db --src=/path/to/database/dump.sql.gz`
8. Update schema: `ddev exec bin/typo3cms database:updateschema`
9. Create a backend user `ddev exec bin/typo3cms backend:createadmin username password`
10. Start the project running `ddev start`
36

Benni Mack's avatar
Benni Mack committed
37
38
## License

39
All code is licensed under GPL2+. All content and graphical creations are licensed under
Benni Mack's avatar
Benni Mack committed
40
41
42
43
44
the Creative Commons license.

## Credits

The project was originally built by b13, and is maintained by the TYPO3 Demo Team.