Repository files navigation

NativeScript empowers you to access native APIs from JavaScript directly. Currently iOS, Android, and visionOS runtimes are provided for rich mobile development across a variety of diverse use cases.

To get started with NativeScript, follow these steps:

1. Install the NativeScript CLI globally:

   npm install -g nativescript

2. Create a new project:

   ns create my-app

3. Navigate into your project directory:

   cd my-app

4. Run your app on an emulator or device:

   ns run android

   or

   ns run ios

1. Setup your local development environment

2. Clone to contribute:

$ git clone https://github.com/NativeScript/NativeScript.git$cd NativeScript# setup workspace for development$ npm run setup# list all available commands to run$ npm start

We love you and your pull requests 🤗. Please follow ourcontributing guide and seeour code of governance to become as involved as you want to be.

• @nativescript/coreSingular primitives offering an easy-to-use API surface for diverse iOS/visionOS/Android APIs implemented with NativeScript.
• @nativescript/typesTypes for both iOS/Android below wrapped up as a convenience.Most commonly used.
• @nativescript/types-iosTypes for iOS.
• @nativescript/types-androidTypes for Android.
• @nativescript/types-minimalA very minimal set of types for only the latest Android and iOS sdks. Most commonly used to optimize Web-based IDE's which auto load all type declarations from node_modules.
• @nativescript/ui-mobile-baseUI mobile base native classes used by core.
• @nativescript/webpackWebpack build utilities and configs used by NativeScript apps.

• NativeScript Home
• NativeScript Tutorials
• NativeScript documentation
• JavaScript starter:https://nativescript.new/javascript
• TypeScript starter:https://nativescript.new/typescript
• Angular starter:https://nativescript.new/angular
• React starter:https://nativescript.new/react
• Solid starter:https://nativescript.new/solid
• Svelte starter:https://nativescript.new/svelte
• Vue starter:https://nativescript.new/vue
• Vue 3 starter:https://nativescript.new/vue3
• NativeScript on Twitter
• NativeScript on Discord
• NativeScript on Stack Overflow

Outside the source centralized in this repo, NativeScript consists of a few other source repos. Here are the major ones:

• iOS and visionOS RuntimeEmpowers JavaScript code to be executed on iOS and visionOS devices written in a mix of C++, Objective-C, and Swift.
• Android RuntimeEmpowers JavaScript code to be executed on Android devices written in a mix of C++, Java and Kotlin.
• CLICommand-line interface empowering you to create, build, and run apps using NativeScript.
• DocsDocumentation available athttp://docs.nativescript.org/ written in Markdown.
• PluginsVarious TSC managed plugins. Also a good reference is theplugin marketplace with several additional plugins.
• FirebaseModular Firebase 🔥 implementation for supported platforms.
• ML KitGoogle'sML Kit SDKs for supported platforms.
• PaymentsIn-App Purchase, Subscriptions, Google Pay and Apple Pay.
• ArtworkWant to use our logo or colors? Feel free to use any of our ready-to-use media material.

CopyrightOpenJS Foundation andNativeScript contributors. All rights reserved. TheOpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of theOpenJS Foundation, please see ourTrademark Policy andTrademark List. Trademarks and logos not indicated on thelist of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

The OpenJS Foundation |Terms of Use |Privacy Policy |OpenJS Foundation Bylaws |Trademark Policy |Trademark List |Cookie Policy