Skip to content

A library of reusable JavaScript modules, written in ES2015.

License

Notifications You must be signed in to change notification settings

VexedBun/goulash

Repository files navigation

Goulash

A library of reusable JavaScript modules, written in ES2015 (and a little ES7).

This library has been designed to be as minimalistic and customizable as possible, trying not to force any particular markup or CSS on the end user but allowing for often used JavaScript to be reused in such a way that the end bundled file is as small as possible. Every function and module in the framework has it's own file, and is imported and included by Browserify only once if used in the code meaning that the final bundle contains only code that has been used, and not thousands of lines of bloat like other frameworks.

Currently there is only a few utility functions, and a Modal class. As I develop websites I'll add to this repository any components I create, in a similar manner to the existing ones.

Some sample file are included in the samples directory. They include a gulpfile.js and package.json that can get you started. Just change the config variable at the top of the gulpfile.js to reflect the correct paths to your assets, and ensure the entire modules_js folder has been added as a subfolder of your JavaScript.

Sample SASS and HTML has been included for some modules, which will give you a barebones and minimalistic starting point. The SASS follows the BEM standard, but most modules have a settings variable where you can change the default class names if you desire to use a different standard like SMACSS, for example.

Changelog

  • 0.1.0
    • Added code from my ModularJS example.
    • Split utilities into separate files to avoid importing lots of unused code.
    • Commented out ESDoc documentation function from gulpfile.js, until a decision can be made on whether to use ESDoc or JSDoc.

About

A library of reusable JavaScript modules, written in ES2015.

Resources

License

Stars

Watchers

Forks

Packages

No packages published