/template-app-cell

Minimal modules needed to build a Personium client app. Take a look at the deploy-minimal-app branch to see what is supposed to be modified.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Description

This repository contains the necessary files (HTML, CSS, JavaScript) needed to create a very simple Personium app which can be launched from the HomeApp.

All you need to do is follow the instructions in the tutorial to import configuration to your app Cell and upload the files (see below) that contain appropriate information (information marked by "***" within this repository)of your app Cell.

Files to be modified and upload to your app Cell

│  launch.json (must use the current app Cell URL)
│  profile.json (must use your App name and icon)
│  
│      
├─locales
│  ├─en
│  │      profile.json  (must use your app name and icon)
│  │      
│  └─ja
│         profile.json  (must use your app name and icon)
│          
└─src
    └─html
        │  
        └─Engine
               acc_info.js (must use your app Cell's information)

Before you start

Either perform the tutorial using our demo environment (demo.personium.io) or make sure you have Unit Admin level permission over your app Cell.

Due to current implemetation of Personium Core, the followings will happen and require you to re-login as Unit Admin.

  1. The app Cell's user account will be overwritten with random password when importing a Cell from another Personium Unit.
  2. Unit/Cell Manager will be logged out automatically after importing a Cell.

How to get an app Cell from us

  1. Join our community through Slack
  2. After your slack account is activated, please write a simple message in "demo-Cell-request" channel so that we will create a new Cell for you.
    You also need to mention that you want an app Cell, too.
  3. Once you receive your newly created app Cell, please change the password of the admin account.

Tutorial

Follow the steps below to create, customize and install your first Personium app.

  1. How to deploy
    Take a look at the guide on How to deploy the minimal app.

  2. How to customize the app
    Feel free to use this app as the base and write your own app. Basically, you can reuse files that contain "common" in their file names. Check here for detailed instructions.

  3. How to Install the app
    Take a look at the guide on How to Install the Minimal App.

  4. How to debug the app
    Install Restlet Client in Chrome and import the scenario. Fill in your app Cell information in Environment variables.

At first, the part getting your friend's data will fail because required permission is not assigned to you. Ask you friend to install the Minimal App and perform How to add member and assign permission.

Coming soon

Currently we only have resources to create web application version of Personium app.
When time permits, we will have iOs and Android versions.

Tips

Some tips on using i18next & Google API.