@volkan/smartface-core-device

 ____                       _    __                      _
/ ___| _ __ ___   __ _ _ __| |_ / _| __ _  ___ ___      (_) ___
\___ \| '_ ` _ \ / _` | '__| __| |_ / _` |/ __/ _ \     | |/ _ \
 ___) | | | | | | (_| | |  | |_|  _| (_| | (_|  __/  _  | | (_) |
|____/|_| |_| |_|\__,_|_|   \__|_|  \__,_|\___\___| (_) |_|\___/
-----------------------------------------------------------------

A smartface.io module to mount the React components to the device environment.

About

This module provides a React substrate for the smartface.io applications.

This module is intended to be used as a dependency to a Smartface runtime.

This module is not intended to be used standalone.

If you have forked an official smartface.io module, you might be already using this module as a dependency.

Installation

Get it from npm:

npm install @volkan/smartface-core-device

Dependencies

You cannot use this module standalone, you need to import it in a smartface.io-capable project; and you have to use the smartface.io Cloud IDE.

Usage Example

// #region Smartface core dependencies
import Application from '@volkan/smartface-component-application';
import { mount } from '@volkan/smartface-core-device';
import React from 'react';
// #endregion

const log = console.log;

/* eslint-disable no-alert */
mount(
    <Application onStart={() => alert( 'smartface.io loves you!' )} />
);
/* eslint-enable no-alert

log( '\n\n*** Smartface app is up and running! ***\n\n' );

Dependencies

You cannot use this module standalone, you need to import it in a smartface.io-capable project; and you have to use the smartface.io Cloud IDE.

Package Scripts

Here are the npm scripts associated with this module:

• npm run test: Runs unit tests.
• npm run lint: Verifies the correctness of the source code.

Important Files and Folders

• ./index.js: The main entry module.
• ./bin: Binaries that are used by the NPM scripts.
• ./package.json: The package definition.
• ./CHANGELOG.md: A log of what has been done since the last version.
• ./CODE_OF_CONDUCT.md: Basically tells the collaborators to be nice to each other.
• ./README.md: This very file.

Wanna Help?

Any help is more than appreciated.

If you want to contribute to the source code, fork this repository and create a pull request.

In lieu of a formal styleguide, take care to maintain the existing coding style.

Also don’t forget to add unit tests for any new or changed functionality.

If you want to report a bug; or share a comment or suggestion, file an issue.

Supported Environments

You have to use this repository from within the smartface.io Cloud IDE.

This demo application crates binaries for Android and iOS devices.

I’ve Found a Bug, I Have an Idea

Please file an issue and lest us know too.

Contact Information

• Project Maintainer: Volkan Özçelik

Code of Conduct

We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

See the code of conduct for details.

From the Smartface Team

Hello Fellow Developer

Thank you for using Smartface Cloud!

Developing native apps for iOS and Android is as easy as a few lines of JavaScript code.

Start coding right away and to view your app instantly on a real device, just click the Run on Device button and follow the instructions.

You can also update your native apps remotely and manage their lifecycle end-to-end, fully in the cloud.

Welcome to the world of mobility!

Smartface Team.

Support, Documentation, and Useful Links

• Guides
• API Docs
• Smartface Cloud Dashboard
• Download Smartface On-Device Emulator (Works only from your device)