Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesper Hess Nielsen committed Jan 27, 2017
0 parents commit 2910caf
Show file tree
Hide file tree
Showing 90 changed files with 29,475 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"plugins": [
"transform-es2015-template-literals",
"transform-es2015-literals",
"transform-es2015-function-name",
"transform-es2015-arrow-functions",
"transform-es2015-block-scoped-functions",
["transform-es2015-classes", { "loose": true }],
"transform-es2015-object-super",
"transform-es2015-shorthand-properties",
["transform-es2015-computed-properties", { "loose": true }],
"check-es2015-constants",
"transform-es2015-spread",
"transform-es2015-parameters",
"transform-es2015-destructuring",
"transform-es2015-block-scoping",
"external-helpers",
"transform-es2015-for-of"
]
}
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.grunt
node_modules
tmp
bin
obj
dist
Properties
SharedJS.csproj.user
*.suo
.idea
.vs
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributing
The OpenAPI JS Connector is an Open Source Project [licensed under the Apache 2.0 License](LICENSE).
We happily accept Pull Requests, so here are a few guidelines to get you started.
## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit [a ticket](https://github.com/saxobank/openapi-connector-js/issues) for your issue, assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it's a bug
* Make sure you fill in the earliest version that you know as the issue
* Fork the repository on GitHub

## Making Changes

* Optionally create a topic branch from where you want to base your work.
* This is usually the master branch.
* Only target release branches if you are certain your fix must be on that
branch.
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your commit messages are in the proper format:

````
Make the example in CONTRIBUTING imperative and concrete
Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.
The first line is a real life imperative statement.
The body describes the behavior without the patch, why this is a problem,
and how the patch fixes the problem when applied. And lastly, if the commit
resolves a specific issue, reference that at the bottom.
Fixes #12
````

* Make sure you have added the necessary tests for your changes.
* Run _all_ the tests to assure nothing else was accidentally broken.

## Submitting Changes

* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository in the SaxoBank organization.
* The core team looks at Pull Requests on a regular basis.
* After feedback has been given we expect responses within two weeks. After two
* weeks we may close the pull request if it isn't showing any activity.

Happy committing!
13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2016 Saxo Bank A/S

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.
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# OpenAPI Client Library

The OpenApi Client Library a JavaScript library for, among other things, consuming OpenAPI endpoints.
The library implements all details regarding security, handshake, heartbeat, endpoint data contracts, subscriptions and batching.
It also has hooks for custom conversion of data and mocked data as well as a bunch of utility functions.

## Building the library

1. Clone the repo
`git clone https://github.com/saxobank/openapi-clientlib-js`
2. Install Node Modules
`npm install`
3. Install Grunt
`npm install -g grunt-cli`
4. Run grunt tasks
`grunt` display a list of possible commands
`grunt jsdoc` build documentation
`grunt dist` build distribution
`grunt test` run unit tests

## Consuming the library

### Pre-built
#### Namespace Setup
If you are not using a module loader, but instead exposing everything in global, then include the package file in your page before any explicit dependencies.
The library will be output to a global `saxo`. You can then use the library immediately like so:
`var priceFormatting = new saxo.PriceFormatting(options);`

#### AMD Setup
If you are using a module loader, such as requirejs, then we recommend you alias the path, since the filename contains a version number.
```
requireConfig: {
// ...
// consumer requirejs configuration
path: {
'openapi-client': 'path/to/openapi-client.js',
// ...
}
}
```
You can then require in the file in the normal way and use as above.
```
var openapi = require("openapi-client");
var prices = new openapi.Prices(options);
```

### Dependencies
|Dependency |Version |Details & URL |
|-----------|------------------------|--------------|
|SignalR |2.0.3 |Signal-R can be downloaded from https://github.com/SignalR/SignalR/releases/tag/2.0.3.|
|jQuery |>1.11 |We do not depend on jQuery, but SignalR does. You can use any version of jquery that SignalR supports.|

### Browser Support
The library requires an ES5-compatible browser and requires fetch and promises to be polyfilled.

# Contributing
You want to contribute? Great! Have a look at our [contribution guidelines](CONTRIBUTING.md).
Loading

0 comments on commit 2910caf

Please sign in to comment.