Quickstart

1. Prerequisites

First install Python, then cookiecutter.

pip install -U cookiecutter

Install Docker.

To share your app publicly you’ll need an account on

• https://github.com (for your app’s code)

• https://hub.docker.com/ (for your app’s executable)

• https://chrisstore.co/ (for your app’s details/meta)

2. Set up

Generate the starter code:

cookiecutter https://github.com/FNNDSC/cookiecutter-chrisapp.git

For app_type choose "ds" (learn what this means in our documentation)

3. Creating a repository

Create a new public repository on https://github.com.

Caution

don’t initialize the repo with a README, a license, or a .gitignore file.

4. Upload your code

Follow Github’s instructions to add your files to git. For example, given a repo name pl-projectapp It should look like

cd pl-projectapp
git init
git add -A
git commit -m "First commit"
git remote add origin https://github.com/FNNDSC/pl-projectapp.git
git push origin master

git tag 1.0.0
git push --tags

5. Build container images

In this example, replace fnndsc with whichever Dockerhub organization you are a member of.

docker build -t fnndsc/pl-projectapp:1.0.0 .
docker push fnndsc/pl-projectapp:1.0.0

6. Register your plugin

Produce a representation (in JSON) of your app’s details/"meta." In the example below, replace "projectapp" with the name of your app.

docker run --rm fnndsc/pl-projectapp:1.0.0 projectapp --json > Projectapp.json

The new file Projectapp.json is ready to be uploaded to https://chrisstore.co/create

Next Steps

Congratulations! Your app is now on chrisstore.co.

Continue on to our developer’s guide to learn about advanced tips and tricks.

The last two steps, building and uploading your ChRIS plugin, can be automated. Find out how: https://github.com/FNNDSC/cookiecutter-chrisapp/wiki/Automatic-Builds