NativeScript ORG

Write Native with TypeScript

259 repos
482 followers
0 following

TypeScript 40%
JavaScript 33%
C++ 5%
C 3%
HTML 3%

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. Quick…

[![NativeScript](./tools/graphics/cover.png)](https://nativescript.org)

![Automated Android Tests Passing](https://github.com/NativeScript/NativeScript/actions/workflows/apps_automated_android.yml)
![Automated iOS Tests Passing](https://github.com/NativeScript/NativeScript/actions/workflows/apps_automated_ios.yml)
![License](https://github.com/NativeScript/NativeScript/blob/main/LICENSE)
![NPM Version](https://www.npmjs.com/@nativescript/core)
![Discord](https://nativescript.org/discord)
![FOSSA Status](https://app.fossa.com/projects/git%2Bgithub.com%2FNativeScript%2FNativeScript?ref=badge_shield)
![website](https://nativescript.org)
![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation)
![support](https://opencollective.com/NativeScript)

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.

![FOSSA Status](https://app.fossa.com/projects/git%2Bgithub.com%2FNativeScript%2FNativeScript?ref=badge_large)

Quick Start

To get started with NativeScript, follow these steps:

1. Install the NativeScript CLI globally:

bash
    npm install -g nativescript

2. Create a new project:

bash
    ns create my-app

3. Navigate into your project directory:

bash
    cd my-app

4. Run your app on an emulator or device:

bash
    ns run android

bash
    ns run ios

Contribute

1. Setup your local development environment

2. Clone to contribute:

bash
$ 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 our contributing guide and see our code of governance to become as involved as you want to be.

@nativescript/*

@nativescript/core

Singular primitives offering an easy-to-use API surface for diverse iOS/visionOS/Android APIs implemented with NativeScript.

@nativescript/types

Types for both iOS/Android below wrapped up as a convenience. *Most commonly used.*

@nativescript/types-ios

Types for iOS.

@nativescript/types-android

Types for Android.

@nativescript/types-minimal

A 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-base

UI mobile base native classes used by core.

@nativescript/webpack

Webpack build utilities and configs used by NativeScript apps.

Other source repos

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

iOS and visionOS Runtime

Empowers JavaScript code to be executed on iOS and visionOS devices written in a mix of C++, Objective-C, and Swift.

Android Runtime

Empowers JavaScript code to be executed on Android devices written in a mix of C++, Java and Kotlin.

Command-line interface empowering you to create, build, and run apps using NativeScript.

Docs

Documentation available at written in Markdown.

Plugins

Various TSC managed plugins. Also a good reference is the plugin marketplace with several additional plugins.

Firebase

Modular Firebase 🔥 implementation for supported platforms.

ML Kit

Google's ML Kit SDKs for supported platforms.

Payments

In-App Purchase, Subscriptions, Google Pay and Apple Pay.

Artwork

Want to use our logo or colors? Feel free to use any of our ready-to-use media material.

Copyright notice

Copyright OpenJS Foundation and NativeScript contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list 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.