README

A simple web application which provides a UI for quick and easy testing of Upmind provision providers.

• Requirements
• Installation
  • Docker (Recommended)
  • Locally
• Development Quick-start
• Usage
  • Screenshots
• Changelog
• Contributing
• Credits
• License
• Upmind

Requirements

To install and run the workbench using Docker via Makefile (recommended) you will need:

• Git
• Docker

To install and run the workbench manually (not recommended) you will need:

• PHP ^8.1
• Composer

Installation

This project is intended to be used as a local development tool only and should NOT be hosted on the internet

Using Makefile

Clone git repository:

git clone https://github.com/upmind-automation/provision-workbench.git && cd provision-workbench

Build and run container (first build may take a few minutes):

make setup

You'll then be able to access the workbench in a web browser at http://127.0.0.1:8000.

Connect to container (for artisan, composer etc):

make shell

Re-cache provision registry (e.g., after adding a new provider or updating data set rules):

make provision-cache

Stop container:

make stop

Remove container and image:

make clean

composer create-project upmind/provision-workbench --keep-vcs

php artisan serve

Development Quick-start

Install a provision category + providers e.g., shared-hosting:

composer require upmind/provision-provider-shared-hosting

Refresh provision registry (e.g., after adding a new provider or updating data set rules):

php artisan upmind:provision:cache

Install a package locally:

git clone https://github.com/upmind-automation/provision-provider-domain-names.git local/domain-names \
  && composer require upmind/provision-provider-domain-names:@dev

Usage

This library makes use of upmind/provision-provider-base primitives which we suggest you familiarize yourself with by reading the usage section in the README.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• Harry Lewis
• All Contributors

License

GNU General Public License version 3 (GPLv3). Please see License File for more information.

Upmind

Sell, manage and support web hosting, domain names, ssl certificates, website builders and more with Upmind.com - the ultimate web hosting billing and management solution.