Replace README with developer contribution guide
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
KirbyCMS Deploy
115
README.md
115
README.md
@@ -1,44 +1,79 @@
|
||||
<img src="http://getkirby.com/assets/images/github/starterkit.jpg" width="300">
|
||||
# hocusfokus-web
|
||||
|
||||
**Kirby: the CMS that adapts to any project, loved by developers and editors alike.**
|
||||
The Starterkit is a full-blown Kirby installation with a lot of example content, blueprints, templates and more.
|
||||
It is ideal for new users to explore many of Kirby's options and get to know the Panel.
|
||||
|
||||
You can learn more about Kirby at [getkirby.com](https://getkirby.com).
|
||||
|
||||
<img src="http://getkirby.com/assets/images/github/starterkit-screen.png" />
|
||||
|
||||
### Try Kirby for free
|
||||
|
||||
You can try Kirby and the Starterkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you’re convinced, [buy your license](https://getkirby.com/buy).
|
||||
|
||||
The Starterkit is a demo of basic Kirby features. It's not recommended to be used "as is" in production. Please, follow our documentation closely for more features and guides on how to build secure, high-quality websites with Kirby.
|
||||
|
||||
While Kirby as the CMS software itself requires you to purchase a license, we consider the files primarily connected to this Starterkit (assets, templates, snippets...) free to use under the MIT license. Feel free to start building your own project with them.
|
||||
|
||||
### Get going
|
||||
|
||||
Read our guide on [how to get started with Kirby](https://getkirby.com/docs/guide/quickstart).
|
||||
|
||||
You can download the latest version of the Starterkit from https://download.getkirby.com/.
|
||||
If you are familiar with Git, you can clone Kirby's Starterkit repository from Github.
|
||||
|
||||
git clone https://github.com/getkirby/starterkit.git
|
||||
|
||||
## What's Kirby?
|
||||
|
||||
- **[getkirby.com](https://getkirby.com)** – Get to know the CMS.
|
||||
- **[Try it](https://getkirby.com/try)** – Take a test ride with our online demo. Or download one of our kits to get started.
|
||||
- **[Documentation](https://getkirby.com/docs/guide)** – Read the official guide, reference and cookbook recipes.
|
||||
- **[Issues](https://github.com/getkirby/kirby/issues)** – Report bugs and other problems.
|
||||
- **[Feedback](https://feedback.getkirby.com)** – You have an idea for Kirby? Share it.
|
||||
- **[Forum](https://forum.getkirby.com)** – Whenever you get stuck, don't hesitate to reach out for questions and support.
|
||||
- **[Discord](https://chat.getkirby.com)** – Hang out and meet the community.
|
||||
- **[YouTube](https://youtube.com/kirbyCasts)** - Watch the latest video tutorials visually with Bastian.
|
||||
- **[Mastodon](https://mastodon.social/@getkirby)** – Spread the word.
|
||||
- **[Instagram](https://www.instagram.com/getkirby/)** – Share your creations: #madewithkirby.
|
||||
Die Website von **hocusfokus** basiert auf [Kirby CMS](https://getkirby.com) und wird auf `https://web.mindboost.team` gehostet.
|
||||
|
||||
---
|
||||
|
||||
© 2009 Bastian Allgeier
|
||||
[getkirby.com](https://getkirby.com) · [License agreement](https://getkirby.com/license)
|
||||
## Für Entwickler: So funktioniert der Workflow
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Git-Zugang zum Repo: `https://gitea.mindboost.team/hocusfokus/hocusfokus-web.git`
|
||||
- Schreibrechte auf dem `main`-Branch
|
||||
|
||||
### Repository klonen
|
||||
|
||||
```bash
|
||||
git clone https://gitea.mindboost.team/hocusfokus/hocusfokus-web.git
|
||||
cd hocusfokus-web
|
||||
```
|
||||
|
||||
### Lokale Entwicklung
|
||||
|
||||
Kirby läuft ohne Datenbank – alle Inhalte liegen als Dateien im `content/`-Ordner. Für eine lokale Vorschau reicht ein einfacher PHP-Server:
|
||||
|
||||
```bash
|
||||
php -S localhost:8000
|
||||
```
|
||||
|
||||
Danach ist die Seite unter `http://localhost:8000` und das Panel unter `http://localhost:8000/panel` erreichbar.
|
||||
|
||||
> **Hinweis:** Die Datei `site/config/config.php` enthält die URL-Konfiguration für die Produktionsumgebung. Lokal kann es sein, dass Kirby eine Warnung wegen der URL zeigt – das ist normal und beeinflusst die Entwicklung nicht.
|
||||
|
||||
### Änderungen deployen
|
||||
|
||||
Das Deployment läuft vollautomatisch über einen Gitea-Webhook:
|
||||
|
||||
1. Änderungen committen und auf `main` pushen
|
||||
2. Gitea löst automatisch einen Webhook aus
|
||||
3. Der Server führt `git pull` im Produktionsverzeichnis aus
|
||||
4. Die Änderungen sind sofort live auf `https://web.mindboost.team`
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Beschreibung der Änderung"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
> Pushes auf andere Branches lösen **kein** Deployment aus. Nur `main` wird automatisch deployed.
|
||||
|
||||
### Projektstruktur
|
||||
|
||||
```
|
||||
├── assets/ # CSS, JS, Bilder (Theme-Dateien)
|
||||
├── content/ # Alle Seiteninhalte als Textdateien
|
||||
├── kirby/ # Kirby CMS Core (nicht bearbeiten)
|
||||
├── media/ # Automatisch generierter Cache (nicht committen)
|
||||
├── site/
|
||||
│ ├── blueprints/ # Panel-Konfiguration (Felder, Layouts)
|
||||
│ ├── config/ # Kirby-Konfiguration
|
||||
│ ├── plugins/ # Erweiterungen
|
||||
│ ├── snippets/ # Wiederverwendbare Template-Teile
|
||||
│ └── templates/ # Seitentemplates
|
||||
└── index.php # Einstiegspunkt
|
||||
```
|
||||
|
||||
### Was gehört ins Repo, was nicht?
|
||||
|
||||
| Gehört rein | Gehört **nicht** rein |
|
||||
|---|---|
|
||||
| `content/` | `media/` (automatisch generiert) |
|
||||
| `assets/` | `site/accounts/` (Benutzerkonten) |
|
||||
| `site/` | `site/sessions/` (Sitzungsdaten) |
|
||||
| `kirby/` | `site/cache/` (Cache) |
|
||||
|
||||
Die `.gitignore` ist bereits entsprechend konfiguriert.
|
||||
|
||||
---
|
||||
|
||||
Fragen zum Setup? Wende dich an das MindBoost-Team.
|
||||
|
||||
Reference in New Issue
Block a user