Skip to content

OpenF2/F2

Repository files navigation

F2 enables smarter financial apps.

The goal of F2 is to define a development standard for the financial services industry that offers a cost saving, risk-reducing method for building innovative, multi-provider solutions.

F2 makes integration simple, standardized and modern. It's the next-generation of content integration created by the team who has the most experience developing integrated solutions in financial services.

Demos

Visit openf2.github.io/F2 for a list of all available demos, including jsFiddle and Codepen examples.

Contributing

F2 is currently maintained by IHS Markit Digital.

Join the team and help contribute to F2 on GitHub. Begin by reading our contribution guidelines, and then start by forking the repo, sending pull requests, or submitting issues.

Thank you to the growing list of contributors!

Developers Build Status

Get F2.js

Docs

The F2 development standard and API docs are available at openf2.github.io/F2.

Contributions

Setup

Be sure you have cloned this repository and have Node.js installed, then run the following command from the project root:

$> npm install

This command will install all dependencies needed to build F2.

Build F2

After any edits to the core F2 javascript or docs, run this task to compile dist:

$> npm run build

For other helpful tasks, see the scripts section of the package.json.

Versioning

The latest version of F2.js will always be in master.

In accordance with industry standards, F2 is currently maintained, in as far as reasonably possible, under the Semantic Versioning guidelines. Releases will be numbered with the following format:

<major>.<minor>.<patch>

For more information on SemVer, please visit SemVer.org.

Upgrading

It is our goal to make upgrading to the latest version of F2 a minor effort for development teams. Read more in the Docs.

Issues, Enhancements, Bugs

Have a question? Find a bug? Open an Issue on GitHub or send an email to info@openf2.org.

To track bugs, issues and enhancement requests, we are using Issues on GitHub.

Copyright and License

Copyright © 2021 IHS Markit Digital

"F2" is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Please note that F2 ("Software") may contain third party material that Markit On Demand Inc. has a license to use and include within the Software (the "Third Party Material"). A list of the software comprising the Third Party Material and the terms and conditions under which such Third Party Material is distributed are reproduced in the ThirdPartyMaterial.md file. The inclusion of the Third Party Material in the Software does not grant, provide nor result in you having acquiring any rights whatsoever, other than as stipulated in the terms and conditions related to the specific Third Party Material, if any.