| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you 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. |
| --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> |
| <meta name="author" content=""> |
| <link rel="icon" href="/favicon.ico"> |
| <title>Apache Olingo Library</title> |
| <!-- Bootstrap core CSS --> |
| <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> |
| <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> |
| <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> |
| <link rel="stylesheet" href="/css/main.css"> |
| <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> |
| <style> |
| .headerlink { |
| visibility: hidden; |
| } |
| dt:hover > .headerlink, p:hover > .headerlink, td:hover > .headerlink, h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink { |
| visibility: visible |
| } </style> |
| <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> |
| </script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> |
| |
| <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> |
| </script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="/js/html5shiv.min.js"></script> |
| <script src="/js/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body> |
| <div class="container"> |
| <!-- Static navbar --> |
| <div class="navbar navbar-default" role="navigation"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > |
| <a class="navbar-brand" href="/">Apache Olingo™</a> |
| </div> |
| <div class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="http://www.apache.org/foundation/">ASF Home</a></li> |
| <li><a href="http://projects.apache.org/">Projects</a></li> |
| <li><a href="http://people.apache.org/">People</a></li> |
| <li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li><a href="http://www.apache.org/dyn/closer.cgi">Download</a></li> |
| <li><a href="http://www.apache.org/security/">Security</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Support Apache</a></li> |
| </ul> |
| </li> |
| |
| <li><a href="http://www.apache.org/licenses/">License</a></li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> |
| <li><a href="/doc/odata4/download.html">Download OData 4.0 Java</a></li> |
| <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> |
| </ul> |
| </li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> |
| <li><a href="/doc/odata4/index.html">Documentation OData 4.0 Java</a></li> |
| <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> |
| </ul> |
| </li> |
| <li><a href="/support.html">Support</a></li> |
| <li><a href="/contribute.html">Contribute</a></li> |
| |
| </ul> |
| |
| <a class="navbar-right" href="http://www.apache.org/foundation/" target="_blank"> |
| <img class="navbar-right" height="50px" src="/img/asf_logo_url.svg" alt="Apache Software Foundation"> |
| </a> |
| |
| </div><!--/.nav-collapse --> |
| </div><!--/.container-fluid --> |
| </div><!-- Main component for a primary marketing message or call to action --> |
| <h1 id="project-setup">Project setup<a class="headerlink" href="#project-setup" title="Permalink">¶</a></h1> |
| <h3 id="software-requirements">Software requirements<a class="headerlink" href="#software-requirements" title="Permalink">¶</a></h3> |
| <ul> |
| <li>Git client</li> |
| <li>NodeJS installation (>= 0.8.0)</li> |
| <li>Java VM ( only for running the Relase audit checks)</li> |
| </ul> |
| <p>Please install this software and check the correct installation with help of the following commands which |
| should produce a similar output on your system:</p> |
| <pre><code>$ git --version |
| git version 1.8.3.msysgit.0 |
| |
| $ node --version |
| v0.11.13 |
| |
| $ npm --version |
| 1.4.6 |
| |
| $ java -version |
| java version "1.7.0_65" |
| Java(TM) SE Runtime Environment (build 1.7.0_65-b20) |
| Java HotSpot(TM) Client VM (build 24.65-b04, mixed mode, sharing) |
| </code></pre> |
| <h3 id="install-global-nodejs-packages">Install global node.js packages<a class="headerlink" href="#install-global-nodejs-packages" title="Permalink">¶</a></h3> |
| <ul> |
| <li> |
| <p>grunt client |
| The grunt client searches the current directory for a grunt configuration file and starts the |
| Grunt installation next the this configuration file. Installation via<br/> |
| <code>npm install -g grunt-cli</code></p> |
| <p>Test via</p> |
| <pre><code> $ grunt -version |
| grunt-cli v0.1.13 |
| </code></pre> |
| </li> |
| </ul> |
| <h3 id="download-source">Download source<a class="headerlink" href="#download-source" title="Permalink">¶</a></h3> |
| <p>Open your (git-)bash and use the following commonand:</p> |
| <p><code>git clone https://gitbox.apache.org/repos/asf/olingo-odata4-js</code></p> |
| <h3 id="install-the-project-dependencies">Install the project dependencies<a class="headerlink" href="#install-the-project-dependencies" title="Permalink">¶</a></h3> |
| <h5 id="javascript">JavaScript<a class="headerlink" href="#javascript" title="Permalink">¶</a></h5> |
| <p>After downloading navigate into the project folder via</p> |
| <p><code>cd olingo-odata4-js/</code></p> |
| <p>and install the dependencies via npm (node package manager) with</p> |
| <p><code>npm install</code></p> |
| <p>npm will check all dependencies listed in the package.json file and install them recursively.</p> |
| <p>If you are working from behind a proxy please set the proxy configaration for npm accordingly</p> |
| <p><code>npm config set proxy http://proxy.company.com:8080</code></p> |
| <p><code>npm config set https-proxy http://proxy.company.com:8080</code></p> |
| <p>Default are the environment variables <em>HTTP_PROXY</em> and <em>http_proxy</em> for <strong>proxy</strong> and |
| <em>HTTPS_PROXY</em>, <em>https_proxy</em>, <em>HTTP_PROXY</em> or <em>http_proxy</em> for <strong>https-proxy</strong>.</p> |
| <h5 id="java">Java<a class="headerlink" href="#java" title="Permalink">¶</a></h5> |
| <p>If you want to run the Apache release audit tools (<a href="http://creadur.apache.org/rat/">Apache Rat™</a> ) please perform the |
| following steps:</p> |
| <ul> |
| <li>Navigate to |
| <code>./olingo-odata4-js/grunt-config/custom-tasks/rat</code></li> |
| <li>Run <code>npm install</code> to install the node_modules required by the rat tool</li> |
| </ul> |
| <p>then</p> |
| <ul> |
| <li>Proceed as described the filed <code>readme.md</code></li> |
| </ul> |
| <h5 id="c">C#<a class="headerlink" href="#c" title="Permalink">¶</a></h5> |
| <p>In order to run the service for testing you need the the "Microsoft Visual Studio SP1" with the extension |
| "NuGet package manager".</p> |
| <p>Please install the following packages via "NuGet package manager":</p> |
| <ul> |
| <li>Microsoft.OData.Client -Version 6.5.0</li> |
| <li>Microsoft.OData.Core -Version 6.5.0</li> |
| <li>Microsoft.OData.Edm -Version 6.5.0</li> |
| <li>Microsoft.OData.Service -Version 6.5.0</li> |
| <li>Microsoft.OData.Spatial -Version 6.5.0</li> |
| </ul> |
| |
| <div align="center"> |
| <p>Copyright © 2013-2022, The Apache Software Foundation<br> |
| Apache Olingo, Olingo, Apache, the Apache feather, and |
| the Apache Olingo project logo are trademarks of the Apache Software |
| Foundation.</p> |
| <small><a href="/doc/odata2/privacy.html">Privacy</a></small> |
| </div> |
| </div><!-- /container --> |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="/js/jquery.js" type="text/javascript"> |
| </script> |
| <script src="/js/bootstrap.js" type="text/javascript"> |
| </script> |
| <script src="/js/offcanvas.js" type="text/javascript"> |
| </script> |
| <link rel="stylesheet" href="/css/docco.css"> |
| <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script> |
| <script>hljs.highlightAll();</script> |
| </body> |
| </html> |
