{"id":23582488,"url":"https://github.com/fork/kirby-starterkit","last_synced_at":"2025-05-06T23:44:26.298Z","repository":{"id":154170816,"uuid":"611464012","full_name":"fork/kirby-starterkit","owner":"fork","description":"An essential Kirby CMS Starter Kit that offers a fast setup along with best practices.","archived":false,"fork":false,"pushed_at":"2025-02-10T14:35:23.000Z","size":32913,"stargazers_count":22,"open_issues_count":7,"forks_count":1,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-31T04:11:14.944Z","etag":null,"topics":["alpine","kirby","php","starter-kit","vite"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fork.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-08T22:01:02.000Z","updated_at":"2025-01-21T00:34:13.000Z","dependencies_parsed_at":"2024-01-25T18:47:27.163Z","dependency_job_id":"f99b94cd-5aed-450a-b863-5d4c9fb9ac04","html_url":"https://github.com/fork/kirby-starterkit","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fork%2Fkirby-starterkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fork%2Fkirby-starterkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fork%2Fkirby-starterkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fork%2Fkirby-starterkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fork","download_url":"https://codeload.github.com/fork/kirby-starterkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252788404,"owners_count":21804280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alpine","kirby","php","starter-kit","vite"],"created_at":"2024-12-27T01:11:45.983Z","updated_at":"2025-05-06T23:44:26.279Z","avatar_url":"https://github.com/fork.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kirby Starterkit\n\nThis project is a very basic but opinionated [Kirby](https://getkirby.com/) (v4) Starterkit using some established Kirby CMS Plugins. The folder structure is following the [\"Public folder setup\"](https://getkirby.com/docs/guide/configuration#custom-folder-setup__public-folder-setup) instructions from the Kirby Guide.\u003cbr\u003e\nFrontend is based on [Vite](https://vitejs.dev/), [tailwindcss](https://tailwindcss.com/) and [Alpine.js](https://alpinejs.dev/).\n\nIt comes with is a development setup based on [Docker](https://www.docker.com/) including [Xdebug](#xdebug) and [Mailpit](#mailpit) as services, but you can choose to use your local environment instead.\n\n![stage](https://github.com/fork/kirby-starterkit/assets/55244/cbb3ea0e-507f-473b-a5ca-368c407bd56f)\n\n## Installation instructions\n\n1. ### Setup Kirby via Docker\n```bash\n$ git clone git@github.com:fork/kirby-starterkit.git .\n$ docker compose up -d\n$ docker compose exec -it php composer install\n```\n\n2. ### Alternative: Setup Kirby via local environment\n\nAfter installing the [essential requirements for Kirby](https://getkirby.com/docs/guide/quickstart) these instructions should be enough to get the project up and running on your local maschine.\n\n```bash\n$ git clone git@github.com:fork/kirby-starterkit.git .\n$ composer install\n$ php -S localhost:8000 -t public kirby/router.php\n```\n\n3. ### Build Frontend\n\nThe frontend build gets ignored by Git so you will have to run it initially.\nIt is build directly to the Kirby public folder by the following command.\n\n```bash\n$ yarn install\n$ yarn build\n```\n\n4. ### Finalize Kirby Setup in the panel\n\nVisit the admin panel at [http://localhost:8000/panel](http://localhost:8000/panel) and finalize the installation.\n\n---\n\n## Develop Frontend\n\nYou could also just start developing Frontend components by starting Vite.\n\n```bash\n$ yarn dev\n```\n\n---\n\n## Additional features when using Docker\n\n### Configure Timezone in Docker service\n\nTo configure the Timezone of the PHP service you can change the build args of the [compose file](./docker-compose.yml) before installation. e.g.:\n\n```bash\nTIME_ZONE: \"Europe/Berlin\"\n```\n\n### Mailpit\n\nThere is a handy [Mailpit](https://mailpit.axllent.org/) service running and configured in the [localhost configuration](./site/config/config.localhost.php). When starting the Docker setup, you can access Mailhog by navigating to http://localhost:8025/.\n\n### Xdebug\n\nThe PHP Service is configured with Xdebug. You can change the needed [XDEBUG_MODE](https://xdebug.org/docs/all_settings#mode) via environment variable when starting the setup.\n\n```bash\n$ XDEBUG_MODE=debug docker compose up -d\n```\n\nIf you are working with Visual Studio Code you could use the following launch.json configuration.\n\n```bash\n{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"name\": \"Listen for Xdebug\",\n      \"type\": \"php\",\n      \"request\": \"launch\",\n      \"port\": 9003,\n      \"pathMappings\": {\n        \"/var/www/html/\": \"${workspaceFolder}\"\n      }\n    }\n  ]\n}\n\n```\n\nFor more information on Docker basics related to Kirby you can find a very good guide in the [Kirby Cookbook](https://getkirby.com/docs/cookbook/setup/kirby-meets-docker#example-4-docker-compose).\n\n---\n\n## Kirby Plugins used\n\n-   [Kirby Staticache Plugin](https://github.com/getkirby/staticache)\n-   [Retour for Kirby](https://github.com/distantnative/retour-for-kirby)\n-   [Kirby SEO](https://github.com/tobimori/kirby-seo)\n-   [Kirby Vite Plugin](https://github.com/arnoson/kirby-vite)\n\n## License\n\nThis \"Kirby Docker Starterkit\" is licensed under the MIT License. Please see License File for more information. [Kirby](https://getkirby.com/) itself is [commercial software](https://getkirby.com/buy) and has its own [commercial license](https://getkirby.com/license).\n\n---\n\n\u003ca href=\"https://www.fork.de\" target=\"_blank\"\u003e\u003cimg src=\"https://github.com/fork/kirby-starterkit/assets/55244/242acd9a-7936-414e-9c9e-984d4f690728\" width=\"38\" height=\"41\" alt=\"Fork Logo\" /\u003e\u003c/a\u003e\u003cbr /\u003e\nBrought to you by [Fork Unstable Media GmbH](https://www.fork.de)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffork%2Fkirby-starterkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffork%2Fkirby-starterkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffork%2Fkirby-starterkit/lists"}