|
1 | 1 | # CodeIgniter DevKit
|
| 2 | + |
2 | 3 | Development toolkit for CodeIgniter libraries and projects
|
3 | 4 |
|
4 | 5 | ## Installation
|
@@ -145,6 +146,44 @@ Composer Unused does one thing: checks that your code actually uses the dependen
|
145 | 146 | have included via Composer. It can be easy to forget to update your **composer.json** when
|
146 | 147 | your code drops a dependency, so this workflow will help track those down.
|
147 | 148 |
|
| 149 | +### Hosting with Vagrant |
| 150 | + |
| 151 | +> **Note** |
| 152 | +> The `Vagrantfile.dist` is unmaintained. It might not work now. |
| 153 | +> Contributions are welcome. |
| 154 | +
|
| 155 | +Virtualization is an effective way to test your webapp in the environment you |
| 156 | +plan to deploy on, even if you develop on a different one. |
| 157 | +Even if you are using the same platform for both, virtualization provides an |
| 158 | +isolated environment for testing. |
| 159 | + |
| 160 | +The codebase comes with a **src/Template/Vagrantfile.dist**, that can be copied to **Vagrantfile** |
| 161 | +and tailored for your system, for instance enabling access to specific database or caching engines. |
| 162 | + |
| 163 | +#### Setting Up |
| 164 | + |
| 165 | +It assumes that you have installed [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and |
| 166 | +[Vagrant](https://www.vagrantup.com/downloads.html) |
| 167 | +for your platform. |
| 168 | + |
| 169 | +The Vagrant configuration file assumes you have set up a [ubuntu/bionic64 Vagrant box](https://app.vagrantup.com/ubuntu/boxes/bionic64) on your system: |
| 170 | + |
| 171 | +```console |
| 172 | +> vagrant box add ubuntu/bionic64 |
| 173 | +``` |
| 174 | + |
| 175 | +#### Testing |
| 176 | + |
| 177 | +Once set up, you can then launch your webapp inside a VM, with the command: |
| 178 | + |
| 179 | +```console |
| 180 | +> vagrant up |
| 181 | +``` |
| 182 | + |
| 183 | +Your webapp will be accessible at http://localhost:8080, with the code coverage |
| 184 | +report for your build at http://localhost:8081 and the user guide for |
| 185 | +it at http://localhost:8082. |
| 186 | + |
148 | 187 | ## Example Files
|
149 | 188 |
|
150 | 189 | Besides the template files, this repo includes some examples for integrating CodeIgniter
|
|
0 commit comments