Skip to content
Snippets Groups Projects
Commit 899ebc9f authored by jurgenhaas's avatar jurgenhaas
Browse files

Move readme to docs

parent 6ad705d4
No related branches found
No related tags found
No related merge requests found
# Usage
## Preparation
- [Install composer](https://getcomposer.org): `sudo wget https://getcomposer.org/composer.phar --output-document=/usr/local/bin/composer && sudo chmod +x /usr/local/bin/composer`
- Disable XDebug for CLI - optional: `sudo phpdismod -s cli xdebug`
- [Install Prestissimo](https://github.com/hirak/prestissimo) - optional: `sudo composer global require "hirak/prestissimo:^0.3"`
## Create new project for local development
```bash
composer create-project lakedrops/d8-project [DIRNAME] --no-interaction
cd [DIRNAME]
# If you also want to use the theme template:
composer config repositories.assets composer https://asset-packagist.org
env CUSTOM_THEME_NAME=[THEMENAME] composer require lakedrops/theme-d8-sass
```
This will build the full structure and create a git repository which you can then use during the full live-cycle of that project.
To install a new site with the included default configuration, use `drush site-install config_installer` and you get a jump-start from that.
## Deploy project to upstream stages
For deployment, both initially and for later updates, follow this:
```
mkdir /PATH/TO/ROOT
cd /PATH/TO/ROOT
git clone YOUR-GIT-REPOSITORY .
composer install
```
Optionally you can also create all the scaffolds by using
```
composer lakedrops
```
To manually update the theme components, if you're using the `lakedrops/theme-d8-sass` package and unintentionally changed one of the core file, then you can always run
```
composer lakedrops-theme-update
```
## Adding new and updating existing components
Edit the composer.json file according to your requirements and then run `composer update`.
## Adding JS packages
### CKEditor Codesnippet
```bash
composer config repositories.codesnippet '{"type": "package","package": {"name": "ckeditorplugin/codesnippet","type": "drupal-library","version": "master","dist": {"type": "zip","url": "https://download.ckeditor.com/codesnippet/releases/codesnippet_4.7.3.zip","reference": "master"}}}'
composer require ckeditorplugin/codesnippet:master drupal/codesnippet
```
### Chosen
```bash
composer config repositories.codesnippet '{"type": "package","package": {"name": "harvesthq/chosen","version": "1.8.2","type": "drupal-library","dist": {"url": "https://github.com/harvesthq/chosen/releases/download/v1.8.2/chosen_v1.8.2.zip","type": "zip"}}}'
composer require harvesthq/chosen
```
# Links
[Using Composer to install Drupal packages through Drupal.org](https://www.drupal.org/node/2718229)
# Credit
[Composer template for Drupal projects](https://github.com/drupal-composer/drupal-project)
...@@ -26,7 +26,8 @@ ...@@ -26,7 +26,8 @@
], ],
"support": { "support": {
"issues": "https://gitlab.lakedrops.com/composer/project/drupal-8/issues", "issues": "https://gitlab.lakedrops.com/composer/project/drupal-8/issues",
"source": "https://gitlab.lakedrops.com/composer/project/drupal-8/tree/master" "source": "https://gitlab.lakedrops.com/composer/project/drupal-8/tree/master",
"docs": "https://devops-tools.docs.lakedrops.com/composer/project/d8/"
}, },
"repositories": [ "repositories": [
{ {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment