Skip to content

Latest commit

 

History

History
113 lines (88 loc) · 3.33 KB

README.markdown

File metadata and controls

113 lines (88 loc) · 3.33 KB

Fossil core components

Fossil is yet another framework built on top of Backbone.JS.

Build Status Code Climate Selenium Test Status

Selenium Test Status

It aims at easing and speed up development of large single page applications, because developping Backbone application should all be about creating Views, Models and Collections.

Fossil provides modular organization, productive views, powerful communication features and lot more...

Install

If you use bower:

bower install fossil-core --save

Git install:

$ git clone https://github.com/themouette/fossil-core.git && cd ./fossil-core && npm install

Usage

Fossil is available as both amd module and standalone build.

<html>
    <head></head>
    <body>
        <div id="l-wrap">
        </div>
        <!--
            as standalone build
        -->
        <script src="../bower_components/fossil-core/fossil-core.gz.js" type="text/javascript" charset="utf-8"></script>

        <!-- as AMD build -->
        <!--
            You are encouraged to combine requirejs with your configuration and
            kernel. It makes html the same for production and development
            environments.
            Have a look to http://themouette.github.io/fossil-core/package-application.md
        -->
        <script src="../bower_components/requirejs/require.js" type="text/javascript" charset="utf-8"></script>
        <script type="text/javascript">
            require.config({
                baseUrl: './',
                paths: {
                    'jquery': 'bower_components/jquery/jquery',
                    'underscore': 'bower_components/underscore/underscore',
                    'backbone': 'bower_components/backbone/backbone',
                    'fossil': 'bower_components/fossil-core/src',
                    'fossil/views': 'bower_components/fossil-view/src'
                },
                shim: {
                    'underscore': {exports: '_'},
                    'backbone': {deps: ['underscore', 'jquery'], exports: 'Backbone'}
                }
            });
            require('kernel');
        </script>
    </body>
</html>

License

Fossil is an open source project licensed under the MIT license. See LICENSE file for more informations.

Commands

Testing

$ npm test

Dev mode

It launches a local server and watcher to build project automaticaly.

$ npm start

project is available under http://localhost:8000