WikiToLearn/wikitolearn-sdk

Name: wikitolearn-sdk

Owner: WikiToLearn

Description: This repository an automated mirror of git.kde.org. Join us on https://t.me/WikiToLearn

Created: 2018-05-20 12:10:45.0

Updated: 2018-05-20 12:17:32.0

Pushed: 2018-05-20 12:17:30.0

Homepage: null

Size: 34

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

wikitolearn-sdk

This repository contains the dev kit for the WikiToLearn's microservices-oriented stack. These tools are helpful to work with the stack in a “point and click” fashion or the nearest approximation possible.

Setup

Minimum requirements:

To setup the WikiToLearn dev kit you have to:

  1. setup the kde: prefix in git with this guide
  2. clone this repository
  3. (optional) create the config/repositories.yml file (an example is config/repositories.example.yml)
  4. create the config/config.yml file (an example is config/config.example.yml)
  5. run $ source ./setup-env
  6. run $ wtl-setup-test to test if you have fulfilled the requirements and the configurations
How to manage services
Build

To build the services you have to run:

$ wtl-services-build

This command clone/pull the repositories and build all the services defined into docker-compose files.

Run

To run the services you have to run:

$ wtl-services-run

This command start all the services.

Data restore

If you need to restore a dump you can run:

$ wtl-migration-dump-load

N.B.: a dump_url must be set within config/config.yml file and the services have to be started.

Stop

To stop the services you have to run:

$ wtl-services-stop`

This command stop and remove the service containers.

A note about the repositories directory

WikiToLearn's repositories will be cloned into the repositories/ directory. This is a non-configurable option. It allows tools to work with the assumption of the relative location of each repository.

LICENSE

See LICENSE file.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.