The DigitalState Platform
Clone or download

README.md

The Platform repository provides a toolkit to help orchestrate instances of the DigitalState Application. It uses a Docker container with Ansible pre-configured to help the developer manage local and remote deployments; from sandbox to production.

This is the central repository and starting point for developers.

works badge Build Status Build status Coverage Status Scrutinizer Code Quality License: MIT

Table of Contents

Quickstart

If you wish to test a stable release of the application in a sandbox, we suggest downloading a tagged release of the Platform repository and using the dev environment setup documentation.

If you wish to further develop the application using the latest development efforts, we suggest downloading the develop branch of the Platform repository and using the lab environment setup documentation.

Requirements

  • Git
  • Docker
  • Docker Compose

If you are on Windows, Windows Pro with HyperV and DockerForWindows are required.

If you are on Mac, DockerForMac is required.

⚠️ Docker Toolkit is not compatible.

Documentation

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Credits

This work has been developed by DigitalState.io