Skip to content

Latest commit

 

History

History
88 lines (77 loc) · 3.01 KB

project-structure.md

File metadata and controls

88 lines (77 loc) · 3.01 KB
Raw
nav-title title description position
Project Structure
Project Structure
NativeScript Android Runtime Project Structure
2

Overview

A NativeScript application has the following project structure:

Eclipse

...
assets/
|-- app/
|-- |-- bootstrap.js
|-- |-- [application logic]
|-- internal/
|-- metadata/
|-- tns_modules/
|-- |-- application/
|-- |-- http/
|-- |-- [more modules]
...
libs/
|-- armeabi-v7a/
|-- |-- libNativeScript.so
|-- x86/
|-- |-- libNativeScript.so
|-- gson-2.2.4.jar
|-- nativescript.jar
|-- android-binding-generator.jar
|-- android-support-v4.jar
...

Android Studio

...
app/
|-- libs
|-- |-- gson-2.2.4.jar
|-- |-- nativescript.jar
|-- |-- android-binding-generator.jar
src/
|-- main/
|-- |-- assets/
|-- |-- |-- app/
|-- |-- |-- |-- bootstrap.js
|-- |-- |-- |-- [application logic]
|-- |-- |-- internal/
|-- |-- |-- metadata/
|-- |-- |-- tns_modules/
|-- |-- |-- |-- application/
|-- |-- |-- |-- http/
|-- |-- |-- |-- [more modules]
|-- |-- jniLibs/
|-- |-- |-- armeabi-v7a/
|-- |-- |-- |-- libNativeScript.so
|-- |-- |-- x86/
|-- |-- |-- |-- libNativeScript.so
...

Folder Description

Following is a brief description of the content of each folder:

assets/app Folder

Contains the application's content, including JavaScript, XML and probably some device-independent resources (e.g. a pictures). A required file is bootstrap.js which will be loaded by the Runtime and will serve as the application's main entry point (see Hello World).

assets/internal Folder

Contains the prepareExtend.js file, which adds TypeScript support on top of the Runtime's extend routine. This file is required.

assets/metadata Folder

Contains the pre-generated metadata used by the Runtime to map JavaScript calls to Java APIs. For more information see Accessing APIs.

assets/tns_modules Folder

Contains the Runtime's JavaScript modules that may be used within the application. If you are familiar with the project structure of a Node.js application then you may think of tns_modules as the equivalent of the node_modules folder. A NativeScript application, initialized through its CLI will by default use the set of cross-platform modules as described here. The folder is not a prerequisite and is only used in case a module without a path hint is required. For more information see Modules.

Note: We have plans to move the tns_modules folder within the app folder, which makes the structure consistent with the Node.js one.

libs Folder

Contains the Runtime's native C++ implementation as well as the dependencies to other Android libraries. The location of the native C++ libraries differs depending on the IDE - they are located in the jniLibs in Android Studio.

See Also