https://github.com/iulyanp/elixir-bundle

A Symfony bundle to integrate Laravel Elixir
https://github.com/iulyanp/elixir-bundle

laravel-elixir symfony symfony-bundle

Last synced: about 1 month ago
JSON representation

A Symfony bundle to integrate Laravel Elixir

• Host: GitHub
• URL: https://github.com/iulyanp/elixir-bundle
• Owner: iulyanp
• License: mit
• Created: 2016-08-20T16:27:34.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-11T17:28:31.000Z (about 8 years ago)
• Last Synced: 2024-09-29T13:44:03.261Z (about 2 months ago)
• Topics: laravel-elixir, symfony, symfony-bundle
• Language: PHP
• Size: 15.6 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/iulyanp/elixir-bundle.svg?branch=master)](https://travis-ci.org/iulyanp/elixir-bundle)

[![StyleCI](https://styleci.io/repos/66156651/shield?branch=master)](https://styleci.io/repos/66156651)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/iulyanp/elixir-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/iulyanp/elixir-bundle/?branch=master)

ElixirBundle

============

`ElixirBundle` is a [Symfony](http://symfony.com/) bundle that integrates [Laravel Elixir](https://github.com/laravel/elixir). 

The purpose of the bundle is to offer elixr() twig function.

This is exactly the same elixir() function from [Laravel](https://laravel.com) blade templating system.

### Requirements

Before you start installing this bundle you must first ensure that Node.js is installed on your machine.

Next, you'll want to install NPM and pull in Gulp as a global NPM package.

## Installation

### Step 1: Require the bundle with composer

Open your terminal and run one of the following commands to download the bundle into your vendor directory.

If you have composer installed globally you can run:

```

$ composer require iulyanp/elixir-bundle

```

Else you can go with:

```

$ php composer.phar require iulyanp/elixir-bundle

```

### Step 2: Register the bundle in your AppKernel class

Register the bundle in the app/AppKernel.php file of your project:

```

 Note! The `web_dir` parameter is the only *required* parameter. If are not set, the other two, will use the defaults.

### Step 4: Generate the package.json and gulpfile files:

If you already have installed `Node.js`, `npm` and `Gulp` you should be all set to run:

```

$ php bin/console elixir:init

```

A base `package.json` and a `gulpfile.js` will be generated into your project root directory.

Then run `npm install` to install all the dependencies and [laravel-elixir](https://github.com/laravel/elixir).

### Usage

Now you can use elixir() function to version a file like this:

```

```

#### Bundle assets

By default the bundle assumes that you'll keep your assets files under the `app/Resources/public` folder.

In case that you have assets on bundles level (ex. src/AppBundle/Resources/public/sass/test.scss) you can compile them with elixir pretty simple.

For our example you'll have something like this:

```

// Set up Elixir tasks.

elixir(function(mix) {

    mix.sass('app.scss')

        .version(['web/css/app.css']);

    mix.sass(

        'test.scss', // the sass file you want to compile

        'web/css/test', // the path where you want the compiled css file to be saved

        'src/AppBundle/Resources/public/sass' // the path where your sass files are kept inside a bundle

    );

});

```

The `test.css` file will be saved to `web/css/test/test.css`.

### License

The ElixirBundle is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).