@nstudio/schematics/README.md

Cross-platform (xplat) tools for Nx workspaces.

<h1 align="center">Cross-platform (xplat) tools for Nx workspaces</h1>
<p align="center"><img src="https://raw.githubusercontent.com/nstudio/xplat/master/xplat-logo.png" align="center" width="400"></p>
<div align="center">

[![Build Status](https://travis-ci.org/nstudio/xplat.svg?branch=master)](https://travis-ci.org/nstudio/xplat)
[![License](https://img.shields.io/npm/l/@nstudio/schematics.svg?style=flat-square)]()
[![NPM Version](https://badge.fury.io/js/%40nstudio%2Fschematics.svg)](https://www.npmjs.com/@nstudio/schematics)
[![NPM Downloads](https://img.shields.io/npm/dt/@nstudio/schematics.svg?style=flat-square)](https://www.npmjs.com/@nstudio/schematics)

</div>
<hr>

When the need arises for cross-platform development in your [Nx workspace](https://nrwl.io/nx) you want versatility, clarity and best practices which are scalable.

**xplat** is an added value pack for [Nx](https://nrwl.io/nx) distributed via an Angular [schematic](https://blog.angular.io/schematics-an-introduction-dc1dfbc2a2b2) to provide out of the box support for cross-platform development. 

With the strength of [TypeScript](https://www.typescriptlang.org/) paired with the power of [Angular](https://angular.io/) we can share a lot of code between various platforms to make our projects easier to maintain and develop.

## Currently supported platforms 

* [Electron](https://electronjs.org/)
  > Build cross platform desktop apps with JavaScript, HTML, and CSS.
* [Ionic](https://ionicframework.com/)
  > Build amazing apps in one codebase, for any platform, with the web.
* [NativeScript](https://www.nativescript.org/)
  > Open source framework for building truly native mobile apps with Angular, Vue.js, TypeScript, or JavaScript.
* [Nest](https://nestjs.com/)
  > A progressive Node.js framework for building efficient, reliable and scalable server-side applications.

## Documentation

* [Setup Guide](https://nstudio.io/xplat/)
* [Generators](https://nstudio.io/xplat/generators/)
* [Design Doc](https://t.co/z2lRxOBFAg)
* [Wiki](https://github.com/nstudio/xplat/wiki/FAQ)

## Talks

* [Super Powered, Server Rendered Progressive Native Apps](https://www.youtube.com/watch?v=EqqNexmu3Ug) by [Nathan Walker](http://github.com/NathanWalker) and [Jeff Whelpley](https://github.com/jeffwhelpley)
* [ngAir 172 - xplat (cross-platform) tools for Nx workspaces with Nathan Walker](https://www.youtube.com/watch?v=0I8D25nab5c)

## Recommended extra tooling

* [Angular Console](https://angularconsole.com/)

## Example repos for different scenarios

* Ionic + Web: https://github.com/nstudio/xplat-sample-ionic-web
* Electron + Web with routing: https://github.com/nstudio/xplat-sample-electron-routing

## Real world apps built with xplat

### Portable North Pole

* Web: https://www.portablenorthpole.com/en/home
* iOS: https://itunes.apple.com/us/app/id902026228?mt=8
* Android: https://play.google.com/store/apps/details?id=com.ugroupmedia.pnp14&hl=en

## Context

* [Why it's Hard to Decide on Technologies](https://medium.com/@adamklein_66511/why-its-hard-to-decide-on-technologies-9d67b6adf157) by [Adam Klein](https://github.com/adamkleingit)

## Contributing

Please see our [guidelines for contributing](https://github.com/nstudio/xplat/blob/master/CONTRIBUTING.md).

[<img alt="NathanWalker" src="https://avatars2.githubusercontent.com/u/457187?v=4&s=117" width="117">](https://github.com/NathanWalker) |[<img alt="m-abs" src="https://avatars3.githubusercontent.com/u/1348705?v=4&s=117" width="117">](https://github.com/m-abs) |[<img alt="sr3dna" src="https://avatars2.githubusercontent.com/u/15936818?v=4&s=117" width="117">](https://github.com/sr3dna) |[<img alt="mbaljeetsingh" src="https://avatars0.githubusercontent.com/u/872762?v=4&s=117" width="117">](https://github.com/mbaljeetsingh) |[<img alt="kamilmysliwiec" src="https://avatars0.githubusercontent.com/u/23244943?v=4&s=117" width="117">](https://github.com/kamilmysliwiec) |[<img alt="madmath03" src="https://avatars3.githubusercontent.com/u/6967675?v=4&s=117" width="117">](https://github.com/madmath03) |
:---: |:---: |:---: |:---: |:---: |:---: |
[NathanWalker](https://github.com/NathanWalker) |[m-abs](https://github.com/m-abs) |[sr3dna](https://github.com/sr3dna) |[mbaljeetsingh](https://github.com/mbaljeetsingh) |[kamilmysliwiec](https://github.com/kamilmysliwiec) |[madmath03](https://github.com/madmath03) |

[<img alt="miguelramos" src="https://avatars3.githubusercontent.com/u/495720?v=4&s=117" width="117">](https://github.com/miguelramos) |
:---: |
[miguelramos](https://github.com/miguelramos) |