> For the complete documentation index, see [llms.txt](https://unicef.gitbook.io/unpp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://unicef.gitbook.io/unpp/technical-documentation/api-documentation.md).

# API Documentation

We use [Swagger](https://django-rest-swagger.readthedocs.io/en/latest/) to document the API's. To view, simply run **/docs** when running the codebase locally or any environment of UNPP as well.

### Code flow

**Github** - branches develop and master are monitored for all changes (pushes) with codefresh hooks

**Codefresh** - after successful push to monitored branch, codefresh starts to build docker images based on new code -> puts some basic tests against new images -> pushes new images to docker hub

**Docker Cloud -** monitors new images on docker hub, get them and deploy accordingly to defined configuration -> application deployed