Quickstart tutorial

How to set up a client/server application

This tutorial shows how to set up a simple client/server application using Phovea. The name of the example application is "Test".

Install the phovea-generator

 npm install -g yo
 npm install -g github:phovea/generator-phovea

Create application repository

Create repository for application. The application repository is the place where the whole application code resides.

1. Go to github.com and create a new repository. Name the repository "test". Don't create a README.
2. Clone it locally: Open a terminal and enter: git clone https://github.com/<username or organization>/test.git

Create a product repository

1. Go to github.com and create a new repository. Name the repository "test_product". The _product suffix is important so that Phovea knows that it is a Product. Don't create a README.
2. Clone it locally: Open a terminal and enter: git clone https://github.com/<username or organization>/test_product.git

Initialize application

cd test
yo phovea:init-app

Follow the wizard

Application Title: Test
Client Only: N
Add nesessary libraries
Plugin name: test
Description: A simple test application
Leave all other fields as they are (just press Enter)

Switch to development branches

In package.json, change under dependencies all phovea references to develop branch.

"phovea_core": "0.1.0" -> "phovea_core": "github:phovea/phovea_core#develop"
"phovea_ui": "0.1.0" -> "phovea_ui": "github:phovea/phovea_ui#develop"

Commit changes

git add *
git commit -m "Initial commit"
git push

If you now go to your Github Test repository, you should see the project the project files and a Readme that explains the installation process.

Create development branch

Stay in the test folder and enter following commands:

git checkout -b develop
git commit -m "New development branch"
git push --set-upstream origin develop

Initialize product

cd test_product
yo phovea:init-product

Follow the wizard

Plugin name: test_product
Description: A test product
Leave project homepage and author's credential as they are
Service type: Web
Service name: Testservice
Primary respository: <username or organization>/test
Primary repository branch: master
Additional plugins: ENTER
Add custom additional plugins: N
Add another service: N

Switch to development

Open phovea_product.json. Edit "branch": "master" -> "branch": "develop"

Commit changes

git add *
git commit -m "Initial commit
git push

Create Workspace

Create new folder named workspace and switch to it.

mkdir workspace
cd workspace

Use phovea generator to create workspace

yo phovea:setup-workspace <username or organization>/test_product
SSH clone: No

Start docker

cd workspace\test
docker-compose up