From d9e7811c4646aac8593f940001d2b50d76a43119 Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 30 Jul 2022 07:16:17 +0900 Subject: [PATCH] docs: move the user guide description to READKME --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index a5509af..982a5a8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # CodeIgniter DevKit + Development toolkit for CodeIgniter libraries and projects ## Installation @@ -150,3 +151,41 @@ your code drops a dependency, so this workflow will help track those down. Besides the template files, this repo includes some examples for integrating CodeIgniter with other third-party resources. These files (in **Examples/**) may change over time and should not be relied on for anything more than a reference for your own code. + +## Hosting with Vagrant + +> **Note** +> The `Vagrantfile.dist` is unmaintained. It does not work now. +> Contributions are welcome. + +Virtualization is an effective way to test your webapp in the environment you +plan to deploy on, even if you develop on a different one. +Even if you are using the same platform for both, virtualization provides an +isolated environment for testing. + +The codebase comes with a **src/Vagrantfile.dist**, that can be copied to **Vagrantfile** +and tailored for your system, for instance enabling access to specific database or caching engines. + +### Setting Up + +It assumes that you have installed [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and +[Vagrant](https://www.vagrantup.com/downloads.html) +for your platform. + +The Vagrant configuration file assumes you have set up a [ubuntu/bionic64 Vagrant box](https://app.vagrantup.com/ubuntu/boxes/bionic64) on your system: + +```console +> vagrant box add ubuntu/bionic64 +``` + +### Testing + +Once set up, you can then launch your webapp inside a VM, with the command: + +```console +> vagrant up +``` + +Your webapp will be accessible at http://localhost:8080, with the code coverage +report for your build at http://localhost:8081 and the user guide for +it at http://localhost:8082.