Download the PHP package tdt/start without Composer

On this page you can find all versions of the php package tdt/start. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package start

tdt/start

Build Status

If you want to start working on The DataTank, start here! This is an installer, a config reader and a router. If you have an empty LAMP stack, this is the right way to go. If you already have a Symfony, Drupal, WordPress, Zend... system installed, you might want to look into the separate packages.

Installation

Composer

We use composer to install all The Datatank's dependencies. Composer is a PHP package manager and installs necessary dependencies for you, instead of having to download those dependencies yourself. These dependencies are described in the composer.json file along with some additional meta-data. For more information about composer, check out their project website.

Open a terminal, and install composer:

Create-project

If you have composer installed, you can get your copy of tdt/start by running:

After that a composer update: composer update is adviced.

Alternative

Clone this git repository to your machine, you can checkout to a certain tag (version) too. After that use composer to get all dependencies.

Getting started

There are two folders in this repository: public/ and app/. Public contains all the publicly accessible files, such as html, javascript and css files. App contains all the bootstrap code which configures and initiates the correct packages.

index.php

Copy the example index.php file from public/index.example.php → public/index.php. Change the environment setting if desired. The default environment setting is production, but if you're looking to develop or test the software you want to change the environment setting to development or testing respectively.

Configuration

Copy the config example files in app/config/ (e.g. app/config/general.example.json → app/config/general.json)

Below we cover each of the configuration files and what their configuration parameters are:

general.json

  1. hostname - The hostname of the server it's installed on e.g. http://localhost/ .
  2. subdir - The subdirectory of the host where you installed The DataTank. Mostly this is the filestructure relative to your www folder. Don't forget the trailing slash if you're filling this in!
  3. timezone - The timezone you're in.
  4. defaultlanguage - The abbreviation of your language e.g. en, nl,...
  5. defaultformat - The default format in which queried data will be presented in if no format is specified with the request.
  6. accesslogapache - The absolute path to the apache log access file. This will be used to perform some statistical queries.
  7. cache - Contains three parameters to perform caching:
    • system - Choose from NoCache or MemCache. If you opt for MemCache, be sure that Memcached is installed.
    • host - The host that the caching system is running on. Note that if NoCache has been used, host and port don't really matter.
    • port - The port to which we have to connect in order to communicate with the caching system.
  8. logging - Contains parameters to log actions that happen within the software:
    • enabled - true/false.
    • path - The absolute path to a directory where we can put the logging files. Make sure PHP has write access to this directory!

db.json

  1. system - The system name of the database. MySQL is strongly advised, although we use an ORM that handles different kinds of databases, we have not tested this thoroughly enough.
  2. host - The host on which the database runs. e.g. localhost
  3. user - The username to connect to the database. Make sure this user has write privileges.
  4. name - The name of the database you want to use to let The DataTank write its meta-data in.
  5. password - The password for the user to connect to the database.

cores.json

This file will contain the regular expressions that will route an HTTP-request to the correct destination. Uncomment the routes in the core entry of the json file, and that should get you going.

auth.json

This file will contains your user(s) for the autheticated parts of The DataTank. Username and password are required. These users are used in combination with routes, serveral routes in the example cores file require the user tdtadmin for example, but here are some more:

Example routes

Virtual host

Below are some examples but you can use any webserver you want.

Nginx

Apache

Rewrites are done by the included .htaccess file

Updating tdt/start

Updating tdt/start isn't something you can do with composer (for now). However you can still upgrade by pulling the latest version with GIT:

All versions of start with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.0
justinrainbow/json-schema Version 1.3.1
tdt/core Version v0.1.3
tdt/pages Version dev-master
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tdt/start contains the following files

Loading the files please wait ....