README.md

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

Contribute

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

@nativescript/*

• @nativescript/core
  • Core iOS/Android for 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.

Quick Links

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

Other source repos

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

• iOS Runtime
  • This repo contains the NativeScript iOS Runtime — the code that hosts NativeScript iOS apps, and allows JavaScript code to be executed on iOS devices. The iOS runtime is written in a mix of C++, Objective-C, and more.
• Android Runtime
  • This repo contains the NativeScript Android Runtime — the code that hosts NativeScript Android apps, and allows JavaScript code to be executed on Android devices. The Android runtime is written in a mix of C++ and Java.
• CLI
  • This repo contains the NativeScript command-line interface, which lets you create, build, and run apps using NativeScript. The CLI is written in TypeScript.
• Docs
  • This repo contains NativeScript documentation, which is available at http://docs.nativescript.org/. The docs are written in Markdown.
• Plugins
  • This repo contains a plugin workspace with several often useful plugins.
• Firebase
  • Modular Firebase 🔥 implementation for iOS & Android.
• ML Kit
  • Google's ML Kit SDKs for iOS and Android.
• Payments
  • In-App Purchase, Subscriptions, Google Pay and Apple Pay.
• Artwork
  • Want to use our logo or colors? This repo contains ready to use media material.

Made with ❤️