Skip to content

Structure of the project

Eugenia Oshurko edited this page Apr 29, 2020 · 11 revisions

The KAMIStudio repository consists of the following directories:

  • kamistudio the main KAMIStudio application package;
  • examples a set of example .JSON files that can be used to import a corpus, interactions and a model;
  • db a set of database resources needed for configuring Neo4j in the KAMIStudio Docker container.

and the following files:

  • setup.py the setup file for python setup.py install;
  • configure.py KAMIStudio configuration script for python configure.py;
  • run.sh bash script for starting the KAMIStudio app (./run.sh);
  • Dockerfile a file containing instructions for assembling a Docker container (see https://docs.docker.com/engine/reference/builder/ for more details on dockerfiles);
  • docker-compose.yml a Docker compose file for assembling a multi-container app (one container for the Neo4j db, one for MongoDB and one for the KAMIStudio app, see https://docs.docker.com/compose/ for more details)

Let's have a closer look at the directories:

Package kamistudio

Blueprint packages

  • home
  • corpus
  • model
  • action_graph
  • nuggets
  • definitions

Flask-specific packages

  • static
  • templates
  • instance
Clone this wiki locally