README.md

ExtJsPackages

ExtJS Packages by Mayflower

Using these packages in your application

• Add the repository

$ sencha repository add mayflower http://mayflower.github.io/ExtJsPackages
Sencha Cmd v5.1.3.61
[INF] Adding remote "mayflower"
[INF] Remote "mayflower" added

• Embed the packages In your app.js adjust the requires array, e.g.:

"requires": [
    "ext-locale",
    "mf-grid-filter-form@1.1.1+",
    "mf-grid-celltooltip@1.0.0+"
]

• Use the code
  • See the example folder in the respective package folder for usage examples.
• Profit!

Contributing

Getting started

• Fork the mayflower/ExtJsPackages to your own GitHub account.
• Clone the fork to your machine:

    $ cd <path_to_workspace>
    $ git clone https://github.com/<your github account>/ExtJsPackages.git
    $ cd ExtJsPackages

• Checkout out a new branch to make your changes on:

    $ git checkout -b <your_new_patch>

• Have a look at Sencha's Guide to JavaScript Style and Best Practices
• Read the JSDuck documentation and take a look at JSduck example.js.
• Use Jasmine to write tests for your new code.

Build Requirements

• ExtJS-5.1.1 (direct download link)
• Sencha Cmd
• JSDuck
• NodeJS
• npm

Setup & Build

• Go to the ExtJsPackages directory.

    $ cd <path_to_workspace>/ExtJsPackages

• Install required node packages with npm:

    $ npm install

• Download and extract the ExtJS framework files into the ext directory:

    $ unzip <path_to>/ext-5.1.1-gpl.zip
    $ mv ext-5.1.1 ext

• build the package with Sencha Cmd:

    $ (cd packages/mf-<package-name>; sencha package build)

Before you submit your contribution

• Run tests:

    $ npm test

• Check code style:

    $ ./node_modules/jscs/bin/jscs packages

• Make sure that sencha packaging runs fine:

    $ cd packages/<package-name>
    $ sencha package build