The eForms SDK Explorer is a single-page web application designed to allow business users and developers alike, to easily explore and compare the information contained in any two versions of the eForms SDK that are available on GitHub.
Copyright 2023 European Union
Licensed under the EUPL, Version 1.2 or – as soon they will be approved by the European Commission – subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at: https://joinup.ec.europa.eu/software/page/eupl
Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.
The purpose of the application is to help any user identify the changes that occurred between any two SDK versions, to assist them while they assess the effort required to upgrade their applications to a newer version of the eForms SDK.
The main goal of the application is to make the comparison of SDK versions more intuitive and more practical than the comparison of JSON and XML files.
The SDK Explorer is integrated in the TED Developer Documentation Portal. You can access at https://docs.ted.europa.eu/eforms-sdk-explorer/
Note
Initially our intention was to keep the application "as simple as possible" so that it can be downloaded and executed locally in your browser without the need for a web server. However, we quickly deviated from this initial intention and decided to integrate the application in the TED Developer Documentation Portal instead. This makes accessing the SDK Explorer more convenient for everyone, and allows us to implement it without being restricted by code safety limitations imposed when browsers execute scripts locally on your computer.
You can select the version to explore as well as the base version to compare it with, by using the drop-down selectors on the top right of the SDK Explorer screen.
The drop-down version selectors only show released versions as well as any pre-releases of unreleased versions.
You can also specify the versions to compare in the query string:
http://docs.ted.europa.eu/eforms-sdk-explorer?version=1.8.0&base=1.5.3
If you are interested in this application, we welcome your contributions:
- You can suggest features and improvements in GitHub Issues.
- You can clone or fork the repository and implement any features or improvements that you would like to add to the SDK Explorer. Please submit your code for merging into the
developbranch with a GitHub Pull Request.
Important
When creating a new feature, or improvement, it is always preferable to first create a GitHub Issue that describes the idea you intend to work on, so that we all have a chance to discuss it and see how it fits in the bigger picture of the application.
Likewise, for bug fixes, make sure there is a GitHub Issue recoded and labeled as bug.
In your commit messages and pull requests, reference the issue number. For example Fixes #7: rest of your commit message here.
If you wish to contribute improvements or fixes to the SDK Explorer, you can start by cloning or forking the repository.
The SDK Explorer is a single-page JavaScript application that runs directly in your browser, eliminating the need for Node.js. However, it's important to note that the SDK Explorer utilizes JavaScript modules. As a result, a local web server is required to run it on your local machine.
Follow these steps to set up and run the SDK Explorer locally:
- Clone or fork the SDK Explorer repository to your local machine.
- Set up a local web server. If you're using Visual Studio Code, you can use the Live Server extension. Alternatively, if you have Node.js installed, you can use a lightweight server like http-server.
- Navigate to the project directory and start your local web server. If you're using Live Server, you can do this by right-clicking on your
index.htmlfile and selecting "Open with Live Server". - Open your web browser and navigate to the local address specified by your server (usually
localhostfollowed by a port number). - You should now be able to view and interact with the SDK Explorer in your browser.
Note
While this project is not a Node.js application, we've included a package.json file to clearly list and manage the JavaScript dependencies. This helps ensure consistency and reproducibility across different environments. However, the application does not rely on Node.js for execution.
This project uses the following open-source libraries:
- Bootstrap: The most popular HTML, CSS, and JS library in the world. Licensed under the MIT License.
- jQuery: A fast, small, and feature-rich JavaScript library. Licensed under the MIT License.
- jsTree: a jQuery plugin, that provides interactive trees. Licensed under the MIT License.
- JsDiff: A JavaScript text differencing implementation. Licensed under the BSD License.
- Diff2Html: A pretty diff to HTML javascript library (diff2html). Licensed under the MIT License.
- Lodash: A modern JavaScript utility library delivering modularity, performance, & extras. Licensed under the MIT License.
- Showdown: A bidirectional Markdown to HTML to Markdown converter written in Javascript. Licensed under the MIT License.
Please see the respective links for license details.