Check-Out Setup A Project

Note: before following this tutorial be sure you have installed the composer command to your OS.

First you will need to clone the project from a repository:

$ git clone git@github.com:fvas-elearning/tk-base.git
$ cd tk-base

once you have checked out the project it is imperative that you select the correct branch you want to work on before we go any further:

$ git branch -r 
 origin/3.0 
 origin/3.2 
 origin/HEAD -> origin/master 
 origin/master 
 origin/ver1
 

In this case we want to checkout and track changes on the "origin/3.2" branch as the is the newest.

$ git checkout -t origin/3.2

Just to check we can run git branch:

$ git branch 
* 3.2            <----- our checked out and tracked branch
 master

Now we can commit our future changes and the remote repository will be updated.

Next you need to create a database for the site using phpmyadmin or some other DB client. be sure to have the DB name user and password handy.

Next to setup the site using `composer install` and answer the prompts:

...
Set the DB hostname [localhost]: 
Set the DB name: dev_um_tkbase 
Set the DB user: dev 
Set the DB password: ******* 
Saving config.php 
Creating .htaccess file 
What is the base URL path [/~godar/Unimelb/tkbase/]: /Unimelb/tkbase/ 
Saving .htaccess file
...

This process downloads the required repositories and created a config.php and .htaccess file if they do not exist.

Now you should be able to brows to the site and you may see the install page that will get the site setup for its first use.

NOTE: due to a recent change in composer you may need to run some extra commands to checkout the lib source for dev environment:

$ rm -rf vendor/ plugin/ html/theme-cube composer.lock
$ composer update --prefer-source

Then to confirm that all the libs are a git clone and can be editable, check if they are all branches by running:

$ tk bs 
uom/apd                   3.0          
uom/tk-form               3.2          
uom/tk-domtemplate        3.2          
uom/tk-uni                3.6          
uom/tk-mvc                3.4          
uom/tk-base               3.4          
uom/tk-framework          3.2          
uom/tk-database           3.4          
uom/tk-table              3.2          
uom/tk-auth               3.2          
uom/tk-map                3.2          
uom/tk-ui                 3.2          
uom/tk-installers         3.2          
uom/tk-plugin             3.4          
uom/tk-mail               3.2          
uom-plg/plg-ldap          3.4          
uom-plg/mailog            3.0          
uom/theme-cube            1.4 

This should show the branch version of every lib. if not try again.