Warning, /wikitolearn/wikitolearn-sdk/README.md is written in an unsupported language. File is not indexed.
0001 # wikitolearn-sdk 0002 0003 This repository contains the dev kit for the WikiToLearn's microservices-oriented stack. 0004 These tools are helpful to work with the stack in a "point and click" fashion or the nearest approximation possible. 0005 0006 ## Setup 0007 **Minimum requirements:** 0008 0009 * git 0010 * docker 0011 * docker-compose 0012 * python3 0013 * python3-argcomplete 0014 * python3-yaml 0015 0016 To setup the WikiToLearn dev kit you have to: 0017 0018 1. setup the `kde:` prefix in git with [this](https://community.kde.org/Sysadmin/GitKdeOrgManual#Let_Git_rewrite_URL_prefixes) guide 0019 2. clone this repository 0020 3. (optional) create the `config/repositories.yml` file (an example is `config/repositories.example.yml`) 0021 4. create the `config/config.yml` file (an example is `config/config.example.yml`) 0022 5. run `$ source ./setup-env` 0023 6. run `$ wtl-setup-test` to test if you have fulfilled the requirements and the configurations 0024 0025 ## How to manage services 0026 0027 ### Build 0028 To build the services you have to run: 0029 0030 `$ wtl-services-build` 0031 0032 This command clone/pull the repositories and build all the services defined into docker-compose files. 0033 0034 ### Run 0035 To run the services you have to run: 0036 0037 `$ wtl-services-run` 0038 0039 This command start all the services. 0040 0041 ### Data restore 0042 If you need to restore a dump you can run: 0043 0044 `$ wtl-migration-dump-load` 0045 0046 N.B.: a `dump_url` must be set within `config/config.yml` file and the services have to be started. 0047 0048 ### Stop 0049 To stop the services you have to run: 0050 0051 $ wtl-services-stop` 0052 0053 This command stop and remove the service containers. 0054 0055 ## A note about the repositories directory 0056 0057 WikiToLearn's repositories will be cloned into the `repositories/` directory. This is a non-configurable option. 0058 It allows tools to work with the assumption of the relative location of each repository. 0059 0060 ## LICENSE 0061 0062 See [LICENSE](LICENSE) file.