Skip to content
Branch: master
Find file History

README.md

NativeScript Core with TypeScript Master Detail Template

App templates help you jump start your native cross-platform apps with built-in UI elements and best practices. Save time writing boilerplate code over and over again when you create new apps.

This Master-Detail template is a fundamental building block for any app that displays collection of objects and their details and need to work both in online and offline mode while utilizing Firebase as a backend. The template uses a RadListView component to display the master list. The RadListView component is part of Progress NativeScript UI.

Key Features

  • Editable master-detail interface
  • Integration with Firebase database
  • Works offline
  • Customizable theme
  • UX and development best practices
  • Easy to understand code

Quick Start

Execute the following command to create an app from this template:

tns create my-master-detail-ts --template tns-template-master-detail-ts

Note: This command will create a new NativeScript app that uses the latest version of this template published to npm.

If you want to create a new app that uses the source of the template from the master branch, you can execute the following:

# clone nativescript-app-templates monorepo locally
git clone git@github.com:NativeScript/nativescript-app-templates.git

# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
tns create my-master-detail-ts --template nativescript-app-templates/packages/template-master-detail-ts

NB: Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!

Walkthrough

Architecture

The application root component is located at:

  • app-root.xml - sets up a Frame that lets you navigate between pages.

The template has the following pages:

  • /cars/cars-list-page.ts - the master list page. It gets the data and displays it in a list. On item tap, it navigates to the item details page.
  • /cars/car-detail-page/car-detail-page.ts - the item details page. Displays the details of the tapped item. Has an Edit button that leads to the edit page.
  • /cars/car-detail-edit-page/car-detail-edit-page.ts - the item details edit page. Provides edit options for the selected item. The Done button saves the changes.

There is one model to represent the data items:

  • /cars/shared/car-model.ts

The template also provides a data service:

  • /cars/shared/car-service.ts - serves as a data layer for the master-detail data items. Wraps the functions that are used to make operations on the Firebase database.

Firebase integration

The template uses the {N} Firebase plugin. The initialization is done before the app starts in the /app.ts file. The initialization script is located at /shared/firebase.common.ts.

[Optional] Firebase database setup

By design the app is connected to a read-only copy of the sample data in Firebase. If you want to see the "edit" functionality in action you will have to clone the sample data and update the app configuration to point to your own Firebase setup. You can find detailed instructions how to achieve that here.

Styling

This template is set up to use SASS for styling. All classes used are based on the {N} core theme – consult the documentation to understand how to customize it. Check it out to see what classes you can use on which component.

It has 4 global style files that are located at the root of the app folder:

  • _app-variables.scss - holds the global SASS variables that are imported on each component's styles.
  • app.scss - the global common style sheet. These style rules are applied to both Android and iOS.
  • platform.android.scss - the global Android style sheet. These style rules are applied to Android only.
  • platform.ios.scss - the global iOS style sheet. These style rules are applied to iOS only.

Each component has 3 style files located in its folder:

  • _page-name.scss - the component common style sheet. These style rules are applied to both Android and iOS.
  • page-name.android.scss - the component Android style sheet. These style rules are applied to Android only.
  • page-name.ios.scss - the component iOS style sheet. These style rules are applied to iOS only.

Get Help

The NativeScript framework has a vibrant community that can help when you run into problems.

Try joining the NativeScript community Slack. The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.

If you have found an issue with this template, please report the problem in the NativeScript repository.

Contributing

We love PRs, and accept them gladly. Feel free to propose changes and new ideas. We will review and discuss, so that they can be accepted and better integrated.

You can’t perform that action at this time.