Warning, /wikitolearn/wikitolearn-math-midtier/README.md is written in an unsupported language. File is not indexed.
0001 # wikitolearn-math-midtier 0002 0003 ## Synopsis 0004 WikiToLearn Math Midtier is a mid-tier service of the WikiToLearn architecture. 0005 Its aim is to serve coarse-grained API and hide complex business logic operations which involve multiple microservices. 0006 0007 0008 ## Development 0009 We use Docker to speed-up development and setup the environment without any dependency issues. 0010 0011 ### Minimum requirements 0012 - Docker Engine 17.09.0+ 0013 0014 ### How to run 0015 It is advisable to run using the `docker-compose.yml` file provided. 0016 First, you have replace your Docker Host IP into the `.env` file. 0017 Second, you need to run the following services on which WikiToLearn Math Midtier strongly depends on: 0018 - Keycloak 0019 - Math backend 0020 - PDF backend 0021 0022 ### API documentation 0023 The API documentation is generated thanks to [Springfox](https://springfox.github.io/springfox/). 0024 A Swagger2 compliant JSON and Swagger UI is available at `/api-docs` and at `/swagger-ui.html` respectively. 0025 0026 > N.B.: Do not use the "Try it out" Swagger UI option, it will be removed as soon as possible. 0027 0028 ## Versioning 0029 We use [SemVer](http://semver.org/) for versioning. 0030 0031 ## License 0032 This project is licensed under the AGPLv3+. See the [LICENSE.md](LICENSE.md) file for details.