Skip to content
Starter project for PHP development on Koldy Framework
Branch: 2.0
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
application
configs
public
tests
tools/vagrant
.gitignore
Vagrantfile
build-and-deploy.sh
build.sh
composer.json
init-dev-after-clone.sh
init.sh
koldy
phpunit.xml
readme.md
start.sh
test.sh

readme.md

Koldy Boilerplate - Starter Project

Use this project as starting project if you plan to use Koldy Framework and all benefits that Framework brings with itself.

Development Environment

After cloning this project, run init.sh in console. init.sh will:

  1. Start Vagrant virtual machine with Ubuntu 18.04
  2. Install Nginx, PHP 7.2 and PostgreSQL 10
  3. Initialize complete project structure, including folders that are under .gitignore
  4. Install Composer and dependencies: Koldy Framework as main dependency, PHPUnit for testing and etc.

When script is done, open http://localhost:5000

Next time you'll want to start the project, use start.sh instead of init.sh.

Koldy Boilerplate Vagrant VM will take only 256MB of RAM, together with complete OS, web server, databases and all other installed services. Not much, isn't it?

Database

To access PostgreSQL database, connect to localhost:5001 with username vagrant, password vagrant and database vagrant.

To access MySQL (MariaDB) database, connect to localhost:5002 with username vagrant, password vagrant and database vagrant.

This boilerplate is already configured to talk to the local MySQL database by default.

Testing

You can start unit tests from your computer by running test.sh. It'll run PHPUnit command on VM. If you want to start tests on VM, then go to /vagrant folder and start ./bin/phpunit command.

Build

Build will usually depend on your frontend environment, but we're not here to solve frontend problems.

To build backend, extend build.sh with your own stuff. We've prepared only version increment as part of build process.

Deployment

The build-and-deploy.sh script will:

  1. Run build.sh
  2. Create deploy folder as output folder
  3. Run Composer install command with optimize autoloader flag
  4. Copy all production files and folders to deploy folder, meaning you won't get tests, tools, storage and other non-production stuff
  5. Run Composer install again, to return to original state

If you run build-and-deploy.sh script on the boilerplate, it'll produce deploy folder of about 1.5MB. This is not mistake.

You can’t perform that action at this time.