https://github.com/pimcore/skeleton
The Pimcore Skeleton - The right package to get your Pimcore project started from the ground up! 💪
https://github.com/pimcore/skeleton
Last synced: about 1 year ago
JSON representation
The Pimcore Skeleton - The right package to get your Pimcore project started from the ground up! 💪
- Host: GitHub
- URL: https://github.com/pimcore/skeleton
- Owner: pimcore
- License: other
- Created: 2018-07-19T08:07:32.000Z (almost 8 years ago)
- Default Branch: 2025.x
- Last Pushed: 2025-04-30T07:48:17.000Z (about 1 year ago)
- Last Synced: 2025-04-30T08:08:40.489Z (about 1 year ago)
- Language: PHP
- Homepage: https://pimcore.com
- Size: 226 MB
- Stars: 114
- Watchers: 24
- Forks: 115
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Pimcore Project Skeleton
This skeleton should be used by experienced Pimcore developers for starting a new project from the ground up.
If you are new to Pimcore, it's better to start with our demo package, listed below 😉
## Getting started
```bash
COMPOSER_MEMORY_LIMIT=-1 composer create-project pimcore/skeleton my-project
cd ./my-project
./vendor/bin/pimcore-install
```
- Point your virtual host to `my-project/public`
- [Only for Apache] Create `my-project/public/.htaccess` according to https://pimcore.com/docs/platform/Pimcore/Installation_and_Upgrade/System_Setup_and_Hosting/Apache_Configuration/
- Open https://your-host/admin in your browser
- Done! 😎
## Docker
You can also use Docker to set up a new Pimcore Installation.
You don't need to have a PHP environment with composer installed.
### Prerequisites
* Your user must be allowed to run docker commands (directly or via sudo).
* You must have docker compose installed.
* Your user must be allowed to change file permissions (directly or via sudo).
### Follow these steps
1. Initialize the skeleton project using the `pimcore/pimcore` image
``docker run -u `id -u`:`id -g` --rm -v `pwd`:/var/www/html pimcore/pimcore:php8.3-latest composer create-project pimcore/skeleton my-project``
2. Go to your new project
`cd my-project/`
3. Part of the new project is a docker compose file
* Run `sed -i "s|#user: '1000:1000'|user: '$(id -u):$(id -g)'|g" docker-compose.yaml` to set the correct user id and group id.
* Start the needed services with `docker compose up -d`
4. Install pimcore and initialize the DB
`docker compose exec php vendor/bin/pimcore-install`
* When asked for admin user and password: Choose freely
* This can take a while, up to 20 minutes
* If you select to install the SimpleBackendSearchBundle please make sure to add the `pimcore_search_backend_message` to your `.docker/supervisord.conf` file inside value for 'command' like `pimcore_maintenance` already is.
5. Run codeception tests:
* `docker compose run --user=root --rm test-php chown -R $(id -u):$(id -g) var/ public/var/`
* `docker compose run --rm test-php vendor/bin/pimcore-install -n`
* `docker compose run --rm test-php vendor/bin/codecept run -vv`
6. :heavy_check_mark: DONE - You can now visit your pimcore instance:
* The frontend:
* The admin interface, using the credentials you have chosen above:
## Pimcore Platform Version
By default, Pimcore Platform Version is added as a dependency which ensures installation of compatible and in combination
with each other tested versions of additional Pimcore modules. More information about the Platform Version can be found in the
[Platform Version docs](https://github.com/pimcore/platform-version).
It might be necessary to update a specific Pimcore module to a version that is not included in the Platform Version.
In that case, you need to remove the `platform-version` dependency from your `composer.json` and update the module to
the desired version.
Be aware that this might lead to a theoretically compatible but untested combination of Pimcore modules.
## Other demo/skeleton packages
- [Pimcore Basic Demo](https://github.com/pimcore/demo)