Prerequisites for Developing Applications with Oracle JET

Familiarize yourself with the third party libraries and technologies that the JET framework uses and choose a development environment before you start developing Oracle JET applications. If you will use the Oracle JET tooling framework to develop web or hybrid mobile applications, install the prerequisite packages.

Prerequisite Knowledge for Working with Oracle JET

Before you can successfully develop applications with Oracle JET, you should be familiar with the third party libraries and technologies that the JET framework uses.

Name Description More Information

jQuery

JavaScript library designed for HTML document traversal and manipulation, event handling, animation, and Ajax. jQuery includes an API that works across most browsers.

http://jquery.com

jQueryUI

JavaScript library built on top of the jQuery JavaScript library. All Oracle JET components are wrapped as jQuery UI widgets.

http://www.jqueryui.com

Knockout

JavaScript library that provides support for two-way data binding

http://www.knockoutjs.com

RequireJS

JavaScript file and module loader used for managing library references and lazy loading of resources. RequireJS implements the Asynchronous Module Definition (AMD) API.

RequireJS: http://www.requirejs.org

AMD API: http://requirejs.org/docs/whyamd.html

JavaScript

Programming language

https://developer.mozilla.org/en/About_JavaScript

CSS

Cascading Style Sheets

http://www.w3.org/Style/CSS

HTML5

Hypertext Markup Language 5

http://www.w3.org/TR/html5

SASS

SASS (Syntactically Awesome Style Sheets) extends CSS3 and enables you to use variables, nested rules, mixins, and inline imports to customize your application’s themes. Oracle JET uses the SCSS (Sasy CSS) syntax of SASS.

http://www.sass-lang.com

If you will be using the tooling framework to create web or hybrid mobile applications, you should also be familiar with the following technologies.

Name Description More Information

Apache Cordova (Hybrid only)

Open source mobile development framework that allows you to use HTML5, CSS3, and JavaScript for cross-platform development targeted to multiple platforms with one code base

http://cordova.apache.org/

Grunt

Open source JavaScript task runner used for tasks such as building, minimizing, and running application code in a browser

http://gruntjs.com/

Node.js

Open source, cross-platform runtime environment for developing server-side web applications, used by Oracle JET for package management. Node.js includes the npm command line tool.

https://nodejs.org

Yeoman

Open source tool used to scaffold web or hybrid applications

http://yeoman.io/

Choose a Development Environment

You can develop Oracle JET applications in virtually any integrated development environment (IDE) that supports JavaScript, HTML5, and CSS3.

If you want to develop hybrid mobile applications using the Oracle JET tooling framework, you can use a platform-specific Software Development Kit (SDK) such as iOS or Android Studio. However, an IDE or SDK is not required for developing Oracle JET applications, and you can also use any text editor to develop your application.

NetBeans IDE version 8.1 and higher includes support for creating HTML5 projects in JavaScript and an Oracle JET Support plugin that contains sample applications and support for code completion. For additional information about creating an Oracle JET application in the NetBeans IDE, see Create an Oracle JET Application in the NetBeans IDE.

For details about developing hybrid applications using the Oracle JET tooling framework, see Getting Started with Oracle JET Hybrid Mobile Application Development.

Install the Prerequisite Packages

If you plan to use the Oracle JET tooling framework to develop web or hybrid mobile applications, you must Node.js, Node.js tooling modules, and the Oracle JET Yeoman generator.

Note:

If you already have some or all of the prerequisite packages installed on your development platform, check that you are using the minimum versions supported by the Oracle JET tooling framework and upgrade as needed. For the list of minimum supported version, see Oracle JET Support.
To install the prerequisite packages:
  1. Install Node.js
  2. Install the Tooling Packages
  3. Install the Oracle JET Yeoman Generator

Install Node.js

Install Node.js on your development machine.

From a web browser, download and install one of the installers appropriate for your OS from the Node.js download page.

After you complete installation and setup, you can enter npm commands from a command prompt to verify that your installation succeeded. For example, to configure a proxy server, use npm config.
npm config set proxy http-proxy-server-URL:proxy-port
npm config set https-proxy https-proxy-server-URL:proxy-port

Include the complete URL in the command. For example:

npm config set proxy http://my.proxyserver.com:80
npm config set https.proxy http://my.proxyserver.com:80

Install the Tooling Packages

Use npm to install Yeoman and Grunt which are required by the Oracle JET tooling framework.

At a command prompt on your development machine, enter the following commands as Administrator on Windows or use sudo on Macintosh and Linux systems:
  1. Install Yeoman: [sudo] npm install -g yo

    Note:

    It may not be obvious that the installation didn’t succeed. Enter npm list –g yo to verify that the command succeeded. If the package isn’t listed, scroll through the install command output to locate the source of the failure.
    • If you receive an error related to a network failure, verify that you have set up your proxy correctly if needed.

    • If you receive an error that your version of npm is outdated, type the following to update the version: [sudo] npm install -g npm.

  2. Install Grunt: [sudo] npm install -g grunt-cli
After you have completed installation, you can verify that the packages installed successfully using:
npm list -g --depth=0

Install the Oracle JET Yeoman Generator

Use npm to install the Yeoman generator for Oracle JET.

  1. At the command prompt of your development machine, enter the following command as Administrator on Windows or using sudo on Macintosh and Linux machines:
    [sudo] npm install -g generator-oraclejet
    

    Tip:

    If you already have a version of the Oracle JET generator on your system, type the following to remove the old version before installing the new one: [sudo] npm uninstall -g generator-oraclejet.
    After you have completed installation, you can verify that the generator installed successfully using:
    npm list -g generator-oraclejet
    
  2. If you use a proxy server, configure HTTP_PROXY and HTTPS_PROXY environment variables.

    The process to set the environment variables depends upon your development environment:

    • Windows

      You can set the variables at a command prompt:

      set HTTP_PROXY=http-proxy-server-URL:proxy-port
      set HTTPS_PROXY=https-proxy-server-URL:proxy-port
      

      Include the complete URL in the command.

      set HTTP_PROXY=http://my.proxyserver.com:80
      set HTTPS_PROXY=http://my.proxyserver.com:80
      

      These settings will last only as long as your terminal session. You can set the variables permanently in Control Panel > System and Security > System > Advanced System Settings > Environment Variables.

    • Macintosh and Linux

      On Mac and Linux systems, the settings depend upon your default shell. For example, on a Mac system using the Bash shell, set the environment variables using the following format:

      export HTTP_PROXY=http-proxy-server-URL:proxy-port
      export HTTPS_PROXY=https-proxy-server-URL:proxy-port
      

      On a Linux system using C Shell, you would use the following format:

      setenv HTTP_PROXY http-proxy-server-URL:proxy-port
      setenv HTTPS_PROXY https-proxy-server-URL:proxy-port
      

      These settings will last only as long as your terminal session. To set the variables permanently on a Mac, add the same two lines to the .bash_profile file in your home directory. For a Linux system using C Shell, add the lines to the .cshrc or .cshrc.user file in your home directory.