smartface-native

(β˜… 78)

Core Modules of Native Libraries. Smartface Native has implementations of Android and iOS native libraries with Smartface Expose Framework.

  • .dockerignore
  • .eslintignore
  • .eslintrc
  • .gitignore
  • .npmignore
  • .prettierrc
  • ARCHITECTURE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • index.js
  • LICENSE.md
  • package.json
  • README.md
  • tsconfig.dev.json
  • tsconfig.json
  • typedoc.js
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/smartface/smartface-native

Downloads the entire project code from GitHub to your computer.

cd smartface-native

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t smartface-native .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 smartface-native

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation