DON'T CLONE THIS BUT USE THE DOWNLOAD OPTION TO SAVE AN ARCHIVE VERSION.
This version of the blueprint uses Polymer2! Once Polymer3 and its surroundings have been matured the blueprint will be updated.
An 'componentized' webapp in the eXistdb context is one that uses W3C Web Components specifically using the Polymer polyfill library.
- a common minimal directory structure (more dirs can be added of course)
- all needed configuration files
- useful development tooling (bower, gulp, Polymer CLI, Ant)
NOTE: the tooling seems diverse as it's using so many different tools but all have their purpose which is explained further down. It's a goal of this app template to simplify the usage of all these tools by preconfiguring them and give you the necessary information about their usage.
What will be needed up-front:
- an installation of eXistdb (3.0 or above recommended)
- a nodejs installation (see below for instructions)
- if using Polymer an installation of the Polymer CLI (highly recommended)
- Apache Ant configured
Don't be scared by this list. It can be done in 3 minutes. Thanks to Chris Misztur there is a more visual description of the process here.
- download this blueprint as a zip
- unpack the zip in your favorite development folder
- this creates a folder with starts with 'app-template-'
- rename the folder to give it your new projectname
- execute ´npm install' to install bower and gulp support. Note: do NOT bower install yet. This will be done by Polymer CLI. However if you don't intend to use that you'll have to setup bower yourself.
- execute ´ant init´ to name your new app. This will put the new name into all needed config files
After these steps a full deployable xar application has been created. Your projectname was filled into all relevant place to configure the app. Of course you can further refine the default controller.xql, add authentication, data and xqueries and so on.
Note: you do NOT have to setup bower manually. This will be done by Polymer CLI automatically.
For Polymer development is Polymer CLI is highly recommended and assumed to be present for the remainder of this document. Please visit the link for installation instructions.
Once you got that running execute these:
- execute
polymer initto setup for Polymer development (see also below) - CLI will ask which kind of template shall be used. Choose one.
- CLI will ask for name and description
- CLI will ask to overwrite index.html. Use 'Y' if ´init´ was called for the first time otherwise 'n'
- CLI will ask to overwrite README.md. Choose 'n' to keep this documentation or get the Polymer generated one. (you'll likely use that for own remarks anyway later)
- You will need to manually adapt the ´<link rel="import"...´ statements in the index.html file generated. (haven't yet found a way to adapt those)
After finishing the above instructions you'll have the setup completed.
Time to go for a test and build the xar with:
ant [xar]
Then:
- deploy that xar into your running eXistdb instance via the packagemanager.
- open up the app. You should see a simple documentation page not saying much except everything went fine and we have our app alive.
From now on you might want to use gulp watchto automatically sync your local changes
into eXistdb. This is a very fast and convenient way to develop web components with eXistdb.
CAUTION: there one nifty detail to watch. Your html files that are hosting (importing components via html imports) MUST be well-formed html files following the xhtml rules ( meta and link tags have to use closing syntax '/>').
The Web Components itself are not well-formed markup and are stored as binary HTML in eXistdb.
For more info about the gulp file see below.
Your work starts by modifying index.html to probably adapting the script and link pathes if necessary. The generated index.html is a standard Polymer documentation page. I usually copy that to 'doc.html' to not loose it and start modifying the index.html.
Once index.html is in shape open up your main component file which will be file you created during polymer init (e.g. my-app.html) and check the polymer import. This is usually not right in this setting and needs to be adapted once to start with 'bower_components'.
You can now go on with actually implementing your Web Component.
Eventually you'll need a new component. Just created new ones via polymer init again to quickly create one. Don't forget to import
it whereever its used.
happy hackin
gulpjs is a JavaScript build tool and knows hundreds of 'tasks' to help client-side development.
For eXistdb application development there is a custom existdb plugin (task) that can talk to eXistdb and deploy files from a local disk into eXistdb.
gulp deploy
will transfer all local files on disk to the target collection in eXistdb. If you've used ´ant init` the target collection will already be configured for you.
IMPORTANT: the app MUST be deployed once into eXistdb before ´gulp deploy´ or gulp watch are run. This is to setup
the application correctly (creating collection, users etc.).
gulp watch
can be started in a terminal once (in the root of your project) and will then watch all files on disk and deploy them into eXistdb ONCE THEY'VE CHANGED. This is very convenient if you prefer a workflow 'from workspace to database'.
What Polymer CLI does for you
Polymer CLI is a powerful tool when working with Polymer.
polymer init
With this command you can create a single new Polymer Web Component or even a whole new application. It must be executed in the root of your project.
IMPORANT: when run initially the Polymer CLI will download all JavaScript dependencies it needs for Polymer development. When run to create new components later on (after setup) you should answer all 'overwrite' questions of the CLI with 'n' to keep the originals.
polymer serve -o
can be used to start a local server that open the index page. This is fine for a quick view if the component is running as expected. For serious development i recommend to use gulp for deployment (see above).
polymer build
will create a production version of all your Polymer Web Components compressed into index.html. It also will remove all unneeded dependencies from 'bower_components'. This command should be executed once the app is ready for production as it reduces the footprint dramatically.
polymer test
will run Polymer tests found in directory 'test'.
NOTE: this is not working perfectly for now so please be aware that it might fail due to browser loading/shutdown problems. The actuals tests however should pass. We'll have to look for a more stable solution in the future.
The relevant test framework can be found here: web-component-tester
What Ant does for you
Ant (as always in eXistdb app development) does the final packaging as a xar app. In this app template the standard build.xml is extended to wrap the ´build` command of the Polymer CLI when the target 'production-xar' is called.
ant init
As described above this must be called once you create your project to rename the relevant parts of the various config-files.
ant xar
This is the default and creates a xar file for deployment into eXistdb. Run this and use eXistdb Package Manager to
install the app into eXistdb before ever calling ´gulp deployorgulp watch`.
ant production-xar
will call ´polymer init´ to make sure all Web Components are optimized before packaging the xar. This is highly recommended to prepare your app for production deployment.
bowerjs is a client-side dependency management tool. It's widely adapted in the web development world. It works with a 'bower.json' file that contains all necessary information. By default all client-side dependencies are kept in a directory called 'bower_components'. In app template this file will be created by Polymer CLI.
bower.json will also serve as a meta-information provider when you want to distribute a component for use with bower in an external application. If you're interested in this use case please be aware that the ignores found in 'bower.json.ignores' are added to bower.json.
bower install
this will read the 'bower.json' file and load all dependencies found there into the local 'bower_components' directory. Note that it will only load dependencies if they are not yet present so it does some caching.
bower search [string]
this can be used to localize a dependency you want to use. It will return a list of available resources which then can be installed.
bower install --save [resource]
this will download the resource and put it into 'bower_components' for usage. Please always use ´--save´ to store the dependency in bower.json. if you're installing a development time dependency use ´--save-dev´ instead.
Note: This is a one-timer - you can skip this step if you got mpm on your system already.
Though not strictly required for development it is recommended that you have an installation of nodejs on your system. It is recommended to use 'nvm' to install nodejs as this eases the process of installation and allows to keep different versions of it on your system without conflicts.
Nodejs is used within this project to drive the gulp tasks. These allow to:
- build CSS from less
- sync your local files into eXistdb with
gulp deployor - sync your changed files into eXistdb with
gulp watch
Please refer to the nvm page for installation instruction or use an installation method described on the nodejs.org homepage.
Polymer comes with a testing framework called Web Component Tester (WCT).
To install it just execute:
npm install -g web-component-tester
When running Polymer-Cli to create a new element or whole project it will also create a 'test' directory for you containing an index.html (test suite) plus a file which is named similar to your new element/project with a '_test' appended.
Please note that having the tests embedded in html is just one way of using WCT. More information can be found on the github page of WCT.
Depending on your project layout you should have a look into these files to check if the import paths are set to the correct locations.
Safari does not work out of the box and needs an extra piece of software. When running WCT on the commandline (in the root of your project)
wct
it will spit out an error and display an url to a jar file that needs to installed to make Safari work. The error also gives instructions on how to install that jar.
A note of caution: the video shows an older API of Polymer in the tests which is not used in Polymer 2 any more. However that is not relevant for the testing procedure itself. You just shouldn't try to copy/paste and expect it to work.
There's a good polycast that explains the procedures in quite detail and is highly recommended when starting to test with WCT.
Unit Testing with Web Components
Testing with Travis and Saucelabs
If you find problems with the information provided above please use the issue-tracker and file a ticket. Same applies to extensions of the app template that you'd like to suggest.