F2 is an open and free web integration framework designed to help you and other financial industry participants develop custom solutions that combine the best tools and content from multiple providers into one, privately-labeled, seamlessly integrated front-end. The essential components defined by the F2 specification are the Container, Apps, Context and Store—all supported under the hood by F2.js, a JavaScript SDK which provides an extensible foundation powering all F2-based web applications.
F2 is maintained by Markit On Demand. Visit OpenF2.org for more information. Follow @OpenF2 on Twitter.
Clone the repo, git clone https://github.com/OpenF2/F2.git, or download the latest version.
If you've cloned the repo and are ready to start building a F2 app, read the documentation. Just want to see examples? Point your browser at http://localhost/F2/examples/.
If you only want to build F2 Containers or Apps, you can skip the Collaboration section below.
Join the team and help contribute to F2 on GitHub. Begin by forking the repo, sending pull requests, or submitting issues.
We've included a build.js file in the project which contains the logic for compiling F2.js and the documentation. The build script runs on Node.js, and has a few dependencies. To install, cd to your F2\build folder, and run the following commands in npm:
$> npm install uglify-js wrench fs-extra yuidocjs optimist handlebars
$> npm install less markitdown -g
Depending on your configuration, you may need to be an admin to install some of these Node packages. Additionally, some packages may need to be installed globally using the -g switch.
To build F2, run:
$> node build
For help, run:
$> node build -h
To adhere to industry standards, F2 will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
<major>.<minor>.<patch>
For more information on SemVer, please visit http://semver.org/.
Have a question? Ask it on our Google Group.
https://groups.google.com/forum/#!forum/OpenF2
To track bugs or issues, we are using Issues here on GitHub.
https://github.com/OpenF2/F2/issues
F2 is released under the MIT License.
Copyright © 2012 Markit On Demand, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.