docs: CMS API and calendars
docs/cms-api.md describes the endpoints TYPO3 serves to MyE&P and the chatbot (/api/hotel, /api/product, /api/calendar-hotels, /api/content/*): key, parameters, responses, errors. It is the other side of MyE&P's API consumer guide. docs/calendars.md covers the price calendar, the Belegungskalender and the iCal feed: which product gets which, the MyE&P endpoints behind them, caching, troubleshooting, and the rule that a product's calendar hotel must carry the BusPro code, not a group house's CMS code (which broke three example trips). The README replaces the TYPO3 base distribution boilerplate and links both. The plugin renaming SQL in ep_products' README is obsolete since the migration. The cmsApiKey description names /api/calendar-hotels. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
1 parent
bf9afd143d
commit
2bd663a9bf
5 files changed
+234
-73
No files matched your search
@@ -1,65 +1,26 @@
|
||||
# TYPO3 CMS Base Distribution
|
||||
# E&P Reisen websites (TYPO3 13)
|
||||
|
||||
Get going quickly with TYPO3 CMS.
|
||||
TYPO3 13 LTS for www.ep-reisen.de and its subsites (ski-boarderweek, snowzone, semesterende-skireisen,
|
||||
ski-wochenenden, …). Products, hotels, regions and dates live in `packages/ep_products`, templates
|
||||
and assets in `packages/ep_theme`. Dates, prices and availability come from **MyE&P** (`EP/myep`),
|
||||
which in turn reads bpn-connect.
|
||||
|
||||
## Prerequisites
|
||||
## Local setup
|
||||
|
||||
* PHP 8.2
|
||||
* [Composer](https://getcomposer.org/download/)
|
||||
DDEV project: `ddev start`, then `ddev composer install` and `ddev npm install && ddev npm run build`.
|
||||
Rebuild the assets after template changes: Tailwind purges classes it does not find in the
|
||||
templates.
|
||||
|
||||
## Quickstart
|
||||
## Documentation
|
||||
|
||||
* `composer create-project typo3/cms-base-distribution project-name ^13`
|
||||
* `cd project-name`
|
||||
- [docs/cms-api.md](docs/cms-api.md): the API TYPO3 serves to MyE&P and the chatbot
|
||||
(`/api/hotel`, `/api/product`, `/api/calendar-hotels`, `/api/content/*`).
|
||||
- [docs/calendars.md](docs/calendars.md): price calendar, Belegungskalender and iCal feed: where
|
||||
the data comes from, caching, and what to check when a calendar does not load.
|
||||
|
||||
Note that this distribution installs most, but not all of the TYPO3 CMS core extensions.
|
||||
Depending on your need you might also want to install other TYPO3 extensions from
|
||||
[packagist.org](https://packagist.org/?type=typo3-cms-framework).
|
||||
## Deployment
|
||||
|
||||
### Setup
|
||||
|
||||
To start an interactive installation, you can do so by executing the following
|
||||
command and then follow the wizard:
|
||||
|
||||
```bash
|
||||
composer exec typo3 setup
|
||||
```
|
||||
|
||||
### Setup unattended (optional)
|
||||
|
||||
If you're a more advanced user, you might want to leverage the unattended installation.
|
||||
To do this, you need to execute the following command and substitute the arguments
|
||||
with your own environment configuration.
|
||||
|
||||
```bash
|
||||
export TYPO3_SETUP_ADMIN_PASSWORD=$(tr -dc "_A-Za-z0-9#=$()/" < /dev/urandom | head -c24)
|
||||
composer exec -- typo3 setup \
|
||||
--no-interaction \
|
||||
--server-type=other \
|
||||
--driver=sqlite \
|
||||
--admin-username=admin \
|
||||
--admin-email="[email protected]" \
|
||||
--project-name="My TYPO3 Project" \
|
||||
--create-site="http://localhost:8000/"
|
||||
echo "Admin password: ${TYPO3_SETUP_ADMIN_PASSWORD}"
|
||||
```
|
||||
|
||||
### Development server
|
||||
|
||||
While it's advised to use a more sophisticated web server such as
|
||||
Apache 2 or Nginx, you can instantly run the project by using PHPs` built-in
|
||||
[web server](https://secure.php.net/manual/en/features.commandline.webserver.php).
|
||||
|
||||
* `TYPO3_CONTEXT=Development php -S localhost:8000 -t public`
|
||||
* open your browser at "http://localhost:8000"
|
||||
|
||||
Please be aware that the built-in web server is single threaded and only meant
|
||||
to be used for development.
|
||||
|
||||
## Next steps
|
||||
|
||||
* [Getting Started with TYPO3](https://docs.typo3.org/permalink/t3start:start)
|
||||
* [Create a Site Package](https://docs.typo3.org/permalink/t3sitepackage:start)
|
||||
`deploy.php` (Deployer). A deploy runs `extension:setup`, resets OPcache and flushes all caches.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in new issue
Block a user