Installation

Requirements

Yarn
PHP >= 7.2.0
Laravel 5.8 (and it's dependencies)

A note about Docker

While Docker is not is not required to use Enso, the documentation will assume you are using Docker for development.

Installation

Install a new Laravel project. Where [SITE_NAME] is the name of your site.

mkdir [SITE_NAME]
docker run --rm -i -v $(pwd):/opt -w /opt shippingdocker/php-composer:latest composer create-project --prefer-dist laravel/laravel=^6.0 [SITE_NAME]
cd [SITE_NAME]

Add the Yadda repository to your projects composer.json

"repositories": [
   {
       "type": "composer",
       "url": "https://packages.maya.agency"
   }
]

Use the temporary docker container to install Enso via composer.

docker run --rm -it -v $(pwd):/opt -v ~/.ssh:/root/.ssh -w /opt shippingdocker/php-composer:latest composer require --prefer-stable yadda/enso-core:^2.0 yadda/enso-utilities:^2.0

Fill in details in .env.
In config/filesystems.php change default to public;

Use the temporary container to publish laravel & enso vendor assets

docker run --rm -it -v $(pwd):/opt -w /opt shippingdocker/php-composer:latest php artisan vendor:publish --all

You can now remove the temporary container.

docker image rm shippingdocker/php-composer:latest

You may need to change the permissions on the enso script
```
sudo chmod 744 enso
```
start your docker container, and then run the enso install script
```
enso start
enso artisan enso:install
```
Add some Enso starter routes to your routes/web.php file.

Route::group(['middleware' => 'auth'], function() {
    Route::post('admin/pages/publish', 'Admin\PagePublishController@publish')->name('admin.pages.publish');
    Route::post('admin/pages/unpublish', 'Admin\PagePublishController@unpublish')->name('admin.pages.unpublish');
    EnsoCrud::routes('admin/pages', "\\" . config('enso.crud.page.controller'), 'admin.pages');
    Route::get('admin', 'Admin\DashboardController@index');
});
Route::get('{page}', ['as' => 'pages.show', 'uses' => 'PageController@show']);

Add meta tags to your main template. In resources/views/layouts/app.blade.php in the <head> remove the <title> element and replace it with:

@include('enso-meta::display')

Install npm dependencies

enso yarn add --dev \
    axios \
    babel-preset-es2015 \
    buble \
    bulma \
    eslint \
    eslint-config-airbnb \
    eslint-config-prettier \
    eslint-plugin-prettier \
    gulp \
    imagemin-svgo@^4.2.0 \
    imagemin-webpack-plugin \
    laravel-mix@^5.0 \
    lodash \
    vue-axios \
    vue-multiselect@next \
    vue-slider-component \
    vuejs-datepicker \
    vue2-leaflet@~0.0.60 \
    moment \
    moment-timezone \
    portal-vue \
    prettier \
    quill \
    quill-render \
    resumablejs \
    stylelint-config-airbnb \
    [email protected] \
    vuedraggable \
    [email protected] \
    vuex \
    webpack-svgstore-plugin

Compile your frontend assets

enso yarn run dev

Your should now be able to use your site!

You might also want to...

There is probably some JavaScript that you don't need in resources/assets/js/app.js and resources/assets/js/bootstrap.js.
Add Google Analytics code to views. See Google Analytics
For image optimization, you will need to install the appropriate libraries
Ensure you restrict CMS access
Check that your development environment is set up for the code quality tools
Set up your project for testing

Development

If you're developing enso-core you can use the following to load your packages from a local directory.

"repositories": [
    {
        "type": "path",
        "url": "./packages/yadda/enso-core"
    },
    {
        "type": "path",
        "url": "./packages/yadda/enso-utilities"
    }
]