This repository contains a template application of Personium and deployment tools.

You can make Personium App ( not Apps that uses Personium ) by extending these codes.

"Personium App" and "Apps that uses Personium"

Rename from config.example.js to config.js and modify it as below.

module.exports = {
  personium: {
    CELL_NAME: "<CELL_NAME>", // A name of Application Cell
    CELL_FQDN: "<CELL_FQDN>", // FQDN of Application Cell
    // ...
  },
};

• <CELL_NAME>, the application Cell's name ( like app-template )
• <CELL_FQDN> reveals application cell's FQDN ( like app-template.demo.personium.io )

Rename from src/assets/launch.example.json to src/assets/launch.json and modify it as below.

{
  "personal": {
    "web": "https://<CELL_FQDN>/__/front/app",
    "android": "***:",
    "ios": "***;"
  }
}

Rename from src/bar/00_meta/00_manifest.example.json to src/bar/00_meta/00_manifest.json and modify it as below.

{
  "bar_version": "2",
  "box_version": "1",
  "default_path": "<DEFAULT_BOX_NAME>",
  "schema": "<CELL_URL>"
}

• <DEFAULT_BOX_NAME> reveals a name of Box created in User Cell when installation is done.
• <CELL_URL> reveals URL of App Cell ( scheme + <CELL_FQDN> + / ).

Rename from src/bar/00_meta/90_rootprops.example.xml to src/bar/00_meta/90_rootprops.xml. ( without modifing )

Rename the file from src/app/frontend/Constants/AppConstant.example.js to src/app/frontend/Constants/AppConstant.js and modify its contents as below.

export const AppConstant = {
  cellUrl: '<CELL_URL>',
  installBoxName: '<BOX_NAME>',
  barFileUrl: '<BAR_FILE_URL>',
};

• <BOX_NAME>, the default target Box name in user Cell. It is often set same as <CELL_NAME> typically.
• <BAR_FILE_URL> , the URL of the bar file to be built in next step. It is often placed somewhere public in App Cell.

npm install

Build bar file with below command.

npm run build-bar

bar file contains structure of Application Box created in User Cell with installation.

This command generates dist/<CELL_NAME>.bar. You can install with this file from Home App Menu.

Build App with below command.

npm run build

This command build application into build folder.

The following command will start a localhost webpack server on port 8080 for application development.

npm run debug

Upload built stuff ( Apps and static-files ) with below command.

npm run deploy

This command refers credentials in env value. Make sure below env value are set before try this code.

You can run this command with setting env value like below command.

In Linux,

PERSONIUM_USER=*** PERSONIUM_PASS=*** npm run deploy

In Windows,

set PERSONIUM_USER=*** && set PERSONIUM_PASS=*** && npm run deploy

Configurign ACL is conducted manually in the Unit Manager administration page.

1. Set exec to all(anyone) in front service.
2. Set read to all(anyone) in public folder.
3. Set read to all(anyone) in locales folder.

Set read to all(anyone) to below (4 files).

• launch.json
• profile.json
• relations.json
• roles.json

In Home App of user who installs bar file above can launch this application by touching icon.

The entrypoint of this application is src/app/frontend/index.js.

import React from "react";
import ReactDOM from "react-dom";

ReactDOM.render(<h1>Hello React!</h1>, document.getElementById("root"));

So, you can implement SPA application with React.js by modifing this codes.