tools-example

This is an example tool for materialscloud.org/tools intended as a starting point for developing new tools.

Prerequisites

• docker >= v18.09
• tools-barebone >= 1.0.0

Usage

1. Fork the tools-example repository and rename it

   git clone https://github.com/materialscloud-org/tools-example
   mv tools-example my-tool
   

2. Follow the steps explained in the README file of tools-barebone to update my-tool further.

Build and run the example

From the main repository folder, run

./admin-tools/build-docker.sh

to build a docker image named tools-example. Then, you can run it with

./admin-tools/run-docker.sh

and finally look at the result with your browser at http://localhost:8091.