ol-ishare (or oli for short) is a new embedded map JavaScript client using the latest OpenLayers library which was itself designed from the outset for use on mobile devices.
Using olUsing ol-ishare we ishare we have produced an embedded map component that is similar in functionality to iShare Lite maps, along with the new Spotlight map creator and a rewrite of Logger.
Release
...
Latest version
If you want to dive into ol-ishare immediately, go to: https://ol-ishare.services.astuntechnology.com/v1/apps/spotlight/index.html for embedding, downloading resources, etc.. This uses the v1 branch. See below for details and the availability of other releases.
Examples
A number of examples of using ol-ishare can be found herein each release, e.g.:
https://ol-ishare.services.astuntechnology.com/v1/examples/index.html
A significant benefit of olof ol-ishare is ishare is that we have structured the JavaScript code in such a way (using UMD bundles) so as to make it far easier for other developers to work with and develop custom solutions by themselves - or for Astun to build and maintain customer specific embedded map components containing bespoke functionality.
Documentation
API documentation for developers can be found in each branch, e.g. https://ol-ishare.services.astuntechnology.com/mainv1/apidoc/
Branches
The current principal branches are:
'v1'
Where the latest v1.x.y release will always be available.
...
. As the code changes, so does the documentation and the correct version for each release is kept alongside that release.
Releases
We use semantic versioning for ol-ishare. This means that the main, or major, version number will only be increased when changes are made that will break existing applications. The next, or minor, version number will change whenever new features are added. The last, or patch, release number increments when bugs are fixed for a given minor version. We make all these releases available publicly to allow you to develop with, and test against, the versions of your choice.
'v1'
https://ol-ishare.services.astuntechnology.com/v1/
Where the latest code for this version will be available.
Use this if: You always want the most recent features and patches implemented automatically.
'v1.x'
E.g.: https://ol-ishare.services.astuntechnology.com/v1.1/
Where the latest patch for a given feature release will be available.
Use this if: You want to progress to a given set of new features at a time of your choosing. While we will not break compatibility with previous feature releases for this version, you may want to rollout changes to your users in a measured way, or update documentation first.
'v1.x.y'
E.g.: https://ol-ishare.services.astuntechnology.com/v1.0.2/
Where a particular patch release will be available.
Use this if: You are ultra-cautious about implementing new patches or wish to test against a given patch.
'main'
https://ol-ishare.services.astuntechnology.com/main/
Where other branches are consolidated and tested before progressing to a release candidate. Minor bugfixes are allowed but any changes to capability or significant work required for a fix should be reviewed via the pull request process and so require use of feature & bugfix branches (temporary or otherwise).
...
This isn’t a release as-such, but it provides access to the main unstable development branch. This should never be used for production apps, but can be used for testing fixes, etc. prior to a release.
Other notable releases
'v1-beta' - Archive of code used by the first customer feedback beta. (https://ol-ishare.services.astuntechnology.com/v1-beta/apps/spotlight/index.html )
Feature & bugfix branches
...