concrete5 / composer
A fully featured skeleton for a composer managed Concrete site
Installs: 17 787
Dependents: 0
Suggesters: 0
Security: 0
Stars: 34
Watchers: 13
Forks: 23
Open Issues: 1
Type:project
Requires
- composer/installers: ^2.2
- concrete5/core: ^9.2
- concretecms/dependency-patches: ^1.7
- symfony/dotenv: ^5|^6|^7
Requires (Dev)
- mockery/mockery: ^1
- pestphp/pest: ^1.23
README
Creating a new project
First choose a name for your project. In this example, our project is called "the_oregon_trail"
$ composer create-project -n concretecms/composer the_oregon_trail
Now you have the latest version of Concrete and you're ready to install!
Note: This is a skeleton project. So once you create a project, you can install your own VCS and change the README and all that.
Starting with the Concrete latest develop
First create a new project
$ composer create-project -n concretecms/composer the_oregon_trail
Then navigate into that project and require the dev-develop
version of concretecms/core
$ cd the_oregon_trail
$ composer require concretecms/core:dev-develop
Installing Concrete
Navigate into your new Concrete project
$ cd the_oregon_trail
and use the interactive install commmand that comes with Concrete's CLI tool
$ ./vendor/bin/concrete c5:install -i
Follow directions and your site will begin installing!
Note: You can also run the CLI tool directly with PHP
$ ./public/concrete/bin/concrete
Install a Concrete package using composer
Find the package you'd like to install on packagist.org (in this case concretecms/sample_composer_package
)
Note: You can also use composer's repository functionality to manage private packages using composer
$ composer require concretecms/sample_composer_package $ ./vendor/bin/concrete c5:package-install sample_composer_package
Compiling JS / CSS assets
This library uses Laravel Mix. See webpack.mix.js. To build assets:
npm install npm run dev # Build for development npm run hot # Build with hot reloading enabled (See hot reloading section) npm run watch # Build with a watcher that rebuilds when files change npm run prod # Build for production
Hot Module Replacement
Hot module replacement (hot reloading) allows you to write code and instantly see the changes in your browser, without reloading the page.
In order to use hot reloading with Concrete, you'll want to use the mix
and mixAsset
helper functions to wrap your
js and css urls. These functions make it so that your assets automatically detect hot reloading mode and output the
appropriate urls, they are safe to use in production:
In a page theme:
<?php use function Concrete5\Composer\mixAsset; ... class PageTheme extends Theme { public function registerAssets() { $this->requireAsset(mixAsset('/path/to/file.js')); } }
<?php use function Concrete5\Composer\mixAsset; ... class Controller extends BlockController { public function registerViewAssets() { $this->requireAsset(mixAsset('/path/to/js/file.js')); $this->requireAsset(mixAsset('/path/to/css/file.css')); } }
or in a theme template:
<?php use function Concrete5\Composer\mix; ?> <script src='<?= mix('/path/to/your/asset.js') ?>'></script> <link href='<?= mix('/path/to/your/asset.css') ?>' />
Free marketplace addons
Do you want to install an add-on that is free in the Concrete marketplace, but not on packagist.org? Go to https://composer.concretecms.org/.