mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-14 18:12:09 +08:00
76 lines
4.2 KiB
Markdown
76 lines
4.2 KiB
Markdown
<p align="center">
|
|
<a href="http://www.nativescript.org">
|
|
<img alt="NativeScript" src="https://d1lfyz5kwt8vu9.cloudfront.net/nativescript-logo-2021.png" width="100"/>
|
|
</a>
|
|
</p>
|
|
|
|
[](https://travis-ci.org/NativeScript/NativeScript)
|
|
|
|
|
|
[NativeScript](http://www.nativescript.org) empowers you to access native APIs from JavaScript directly. The framework currently provides iOS and Android runtimes for rich mobile development and can be utilized in a number of diverse use cases.
|
|
|
|
## Setup and Installation
|
|
|
|
* [Environment Setup](https://docs.nativescript.org/environment-setup.html)
|
|
|
|
## 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 PR's 🤗. Please follow our [contributing guide](https://github.com/NativeScript/NativeScript/blob/master/tools/notes/CONTRIBUTING.md) and see [our code of governance](https://github.com/NativeScript/management/blob/master/nativescript-governance.md) to become as involved as you want to be.
|
|
|
|
## @nativescript/*
|
|
|
|
* [@nativescript/core](https://github.com/NativeScript/NativeScript/tree/master/packages/core)
|
|
* Core iOS/Android for NativeScript
|
|
* [@nativescript/types](https://www.npmjs.com/package/@nativescript/types)
|
|
* Types for both iOS/Android below wrapped up as a convenience. *Most commonly used.*
|
|
* [@nativescript/types-ios](https://github.com/NativeScript/NativeScript/tree/master/packages/types-ios)
|
|
* Types for iOS
|
|
* [@nativescript/types-android](https://github.com/NativeScript/NativeScript/tree/master/packages/types-android)
|
|
* Types for Android
|
|
* [@nativescript/ui-mobile-base](https://github.com/NativeScript/NativeScript/tree/master/packages/ui-mobile-base)
|
|
* UI mobile base native classes used by core
|
|
* [@nativescript/webpack](https://github.com/NativeScript/NativeScript/tree/master/packages/webpack)
|
|
* Webpack build utilities and configs used by NativeScript apps
|
|
|
|
## Quick Links
|
|
|
|
- [NativeScript home page](https://nativescript.org)
|
|
- [NativeScript playground](https://play.nativescript.org)
|
|
- [NativeScript and Angular](https://play.nativescript.org/?template=play-ng&tutorial=getting-started-ng)
|
|
- [NativeScript on Twitter](http://twitter.com/NativeScript)
|
|
- [NativeScript on Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript)
|
|
- [NativeScript documentation](https://docs.nativescript.org/)
|
|
|
|
## 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](https://github.com/NativeScript/ns-v8ios-runtime)**
|
|
- [](https://www.npmjs.com/package/@nativescript/ios)
|
|
- 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 fun mix of C++, Objective-C, and more.
|
|
- **[Android runtime](https://github.com/NativeScript/android-runtime)**
|
|
- [](https://www.npmjs.com/package/tns-android)
|
|
- 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 fun mix of C++ and Java.
|
|
- **[CLI](//github.com/NativeScript/nativescript-cli)**
|
|
- [](https://www.npmjs.com/package/nativescript)
|
|
- This repo contains the NativeScript command-line interface, which lets you create, build, and run apps using the NativeScript framework. The CLI is written in TypeScript.
|
|
- **[Docs](//github.com/NativeScript/docs-new)**
|
|
- [](https://docs.nativescript.org/)
|
|
- This repo contains the NativeScript framework documentation, which is available at <http://docs.nativescript.org/>. The docs are written in Markdown.
|
|
|
|
## License
|
|
[](https://github.com/NativeScript/NativeScript/blob/master/LICENSE)
|
|
|
|
<h3 align="center">Made with ❤️</h3>
|