README

Trunk

Frontend framework for cool kids

Installation

Make sure all dependencies have been installed before moving on:

Node.js >= 8.0.0
Laravel Mix >= 5.0.0

npm install --save @cherrypulp/trunk

Webpack

// webpack.mix.js
...
mix.webpackConfig({
    resolve: {
        alias: {
            # required for autoload
            '@': path.resolve(__dirname, paths.src),
        },
    },
});
...

Quick start

Configuration and Setup

Take a look to config/ directory. You can setup a lot of things there.

# mandatory
# TODO

import { Application } from '@cherrypulp/trunk';

const app = new Application();

// Bind Dependencies
app.bind('Http', axios);

// Register Service Providers
app.register(new MyAwesomeServiceProvider(app));

document.addEventListener('DOMContentLoaded', () => app.boot());

Structure

assets/
|--- js/
|    |--- config/                           # autoloaded by ConfigServiceProvider
|    |    |--- app.js
|    |--- main.js
|--- scss/
|    |--- config/                           # autoloaded by @cherrypulp/trunk/src/scss/index.scss
|    |    |--- index.scss

Documentation

Container

Binding dependencies

app.bind('Http', axios);

# TODO

Versioning

Versioned using SemVer.

Contribution

Please raise an issue if you find any. Pull requests are welcome!

Author

Stéphan Zych - monkey_monk

License

This project is licensed under the MIT License - see the LICENSE file for details.

Usage no npm install needed!