semanticdreamer / mite-api-customer-projects-report

Summarized report of time tracked per customer on mite. projects.

mite-api-customer-projects-report

Summarized report of time tracked per customer on mite. projects.

Setup

Install Composer, a Dependency Manager for PHP (execute in project root):

cd app/ && curl -s http://getcomposer.org/installer | php

Install PHP Dependencies, managed by Composer (execute in project root).

php composer.phar install

(Optional, recommended for development environment though, e.g. to have documentation at hand) Install Dependencies as Git submodules into dependencies/ (execute in project root):

git submodule update --init --recursive

Rename config.yml.dist to config.yml and adjust configuration to your needs, in particular add mite. customer account information in section accounts.

File System Layout

public_html/

Contains the application's .htaccess and index.php files.

The index.php file is where the Slim Framework application is instantiated and run.

Public assets, e.g. CSS stylesheets (*.css), images, and scripts (e.g. JavaScripts, *.js), are also in this directory.

app/

Contains the application’s code that should not be available in the public document root.

app/composer.json

Contains project dependencies, managed by Composer.

app/vendor/

Contains third-party libraries. Directory managed by Composer.

app/ext

Contains third-party classes and libraries shipped with the app (i.e. NOT managed by Composer).

app/lib/

Contains custom libraries used by the application.

app/routes/

Separate route files, required by public_html/index.php.

dependencies/

(Optional) Git submodules of third party libraries .

Dependencies

Project's PHP dependencies, managed by Composer.

• Slim - A RESTful micro framework for PHP 5 inspired by Sinatra.
• Slim Framework Extras - Custom Views (e.g. MustacheView).
• Twig - The flexible, fast, and secure template language for PHP.
• Symfony YAML Component - A Component that loads and dumps YAML files.
• Bootstrap, from Twitter - Simple and flexible HTML, CSS, and Javascript for popular user interface components and interactions."

Dev Notes (to-be-deleted)

• Slim Framework Documentation

• How to organize a large Slim Framework application

Path to MAMP's PHP 5.3 binary on OS X:

/Applications/MAMP/bin/php/php5.3.6/bin/php

Install Composer:

cd app/ && curl -s http://getcomposer.org/installer | /Applications/MAMP/bin/php/php5.3.6/bin/php

Install Dependencies via Composer:

cd app/ && /Applications/MAMP/bin/php/php5.3.6/bin/php composer.phar install

Update Dependencies via Composer:

cd app/ && /Applications/MAMP/bin/php/php5.3.6/bin/php composer.phar update