Gulp scripts for redCORE

1. Description
2. Setup
   2.1. Standalone redCORE
   2.2. Integration with third part extensions
   2.2.1. Add redCORE extensions to your extensions file
   2.2.2. Install required npm packages
3. Usage
4. License

1. Description

These are a set of Gulp scripts for redCORE to integrate it with the joomla-gulp system.

2. Setup

These scripts can be used for standalone redCORE development or in projects that integrate redCORE as a dependency.

2.1. Standalone redCORE setup

See redCORE contributing guidelines.

2.2. Integration with third party extensions

If your extension uses redCORE + joomla-gulp you can use these scripts to ensure that your Gulp system control tracks everything.

2.2.1. Add redCORE extensions to your extensions file

You have to add redCORE extensions to your extension gulp-extensions.json file. Remember to always check the latest extensions file to see the list of extensions with Gulp scripts in redCORE.

This is a sample redCORE gulp-extensions.json file:

{
	"components" : ["redcore"],
	"libraries"  : ["redcore"],
	"media"      : ["redcore"],
	"modules"    : {
		"frontend"       : ["redcore_langswitcher"]
	},
	"plugins"    : {
		"redpayment"     : ["paypal"],
		"system"         : ["redcore", "mvcoverride"]
	}
}

If your extension has a gulp-extensions.json file like:

{
	"components" : ["mipayway", "package"],
	"libraries"  : ["mipayway"],
	"modules"    : {
		"frontend"       : ["member", "mybeacons", "shop", "transactions", "statistics", "cart"],
		"backend"        : ["count", "members_chart"]
	},
	"plugins"    : {
		"authentication" : ["mipayway", "mipayway_pin"],
		"mipayway"       : ["autoshop", "email", "usertypes", "push"],
		"redpayment"     : ["paypal"],
		"system"         : ["mipayway"],
		"user"           : ["mipayway"]
	}
}

The end result will be something like:

{
	"components" : ["redcore", "mipayway", "package"],
	"libraries"  : ["redcore", "mipayway"],
	"media"      : ["redcore"],
	"modules"    : {
		"frontend"       : ["member", "mybeacons", "redcore_langswitcher", "shop", "transactions", "statistics", "cart"],
		"backend"        : ["count", "members_chart"]
	},
	"plugins"    : {
		"authentication" : ["mipayway", "mipayway_pin"],
		"mipayway"       : ["autoshop", "email", "usertypes", "push"],
		"redpayment"     : ["paypal"],
		"system"         : ["redcore", "mvcoverride", "mipayway"],
		"user"           : ["mipayway"]
	}
}

The final file is the result of mixing redCORE + your extension gulp-extensions.json files.

2.2.2 Install required npm packages

These Gulp scripts relay on some npm packages. So if your project is not already using them you have to install them.

The easiest to install dependencies is by running the command:

npm install gulp joomla-gulp gulp-redcore fs del browser-sync gulp-less gulp-minify-css gulp-rename gulp-uglify --save-dev

3. Usage

Usage is described in the joomla-gulp documentation

4. License

This scripts are licensed under the GPL v2.0 license

Copyright (C) 2015 redCOMPONENT.com - All rights reserved.