Skip to content
This repository has been archived by the owner on Aug 24, 2019. It is now read-only.

Latest commit

 

History

History
70 lines (54 loc) · 7.1 KB

README.md

File metadata and controls

70 lines (54 loc) · 7.1 KB

❗ ❗ PROJECT HAS BEEN MOVED ❗ ❗

➡️ This project has been moved to https://github.com/Sintattica/atk ⬅️

Development of the ATK Framework as a community project has stopped a very long time ago. This repository exists for historical reasons only and is thus archived. We highly discourage using this repository of the ATK Framework, it contains known security issues! It won't work with recent PHP versions either.

Luckily this isn't the end of the ATK Framework. @Sintattica took over development and is still supporting the ATK Framework as an Open Source project. We highly recommend switching to their code base.

❗ ❗ PROJECT HAS BEEN MOVED ❗ ❗

ATK Framework

The ATK Framework is a special purpose PHP framework targeted at business applications. It allows you to build an application with very small amounts of code.

Its focus on business features makes it an excellent framework for HRM, CRM, data management and CMS type applications. The ATK Framework is stable and suitable for production. For more information, see the ATK Framework GitHub project wiki and the ATK Framework website.

The purpose of the the ATK Framework project on GitHub is to create, as a community, the leading rapid-development framework for creating enterprise web applications, such as Achievo for enterprise resource management. The ATK Framework was created by ibuildings.nl and development is now carried on by the open source community, managed by the GitHub atkphpframework group, with the endorsement and permission of ibuildings.nl.

To Get Started

Applications built using the ATK Framework can be hosted on a standard web application AMP stack (Apache/MySQL/PHP), and is compatible with current AMP stack component versions (e.g. PHP 5.4.x, MySQL 5.5.x). ATK requires PHP 5.1.3 or newer.

The most convenient way to get started using the ATK Framework is to clone the ATK Framework GitHub repository to your webserver. The master branch, containing the most recent production release, will be automatically checked out. Besides the master branch, the repository includes a number of previous release branches, including release-6.4 which is being maintained for Achievo (until Achievo has been migrated to the current release).

If you want to learn about the ATK Framework, an ATK Framework demo appliation is available. The demo is lesson-based, with the lessons covering the basic functionality and features of ATK Framework.

Version Control and Issue Tracking

Communication Channels

Developers using the ATK Framework discuss problems and solutions, keep each other informed, and generally help each other out, on the Achievo/ATK forum. It's a good idea to create a free user profile on the forum, you will need it to post topics or reply to existing topics (although viewing does not require a profile). If you create a new topic, please be careful to submit it in an ATK Framework sub-forum (not an Achievo sub-forum).

Developer Guidelines

See Developer Guideines in the ATK Framework project wiki.

Documentation

Official project documentation (although still somewhat sparse) is in the ATK Framework GitHub project wiki, with valuable discussion topics in the Achievo/ATK forum. The ATK Framework website is a valuable resources, as well as the ibuildings Achievo/ATK wiki(although detailed information may not be current, updated information is published on the ATK Framework GitHub project wiki). The ATK Framework is documented internally with PHPDoc comments, and the ATK Framework API documentation can also be browsed on the ATK Framework website.

Support

In the event you have a problem:

  • Review ATK Framework behavior using an unaltered production-release of the ATK Framework Demo.
  • Search the ATK GitHub project wiki and the ibuildings Achievo/ATK wiki.
  • Search the Achievo/ATK forum.
  • Search the ATK GitHub project Issues and ibuildings legacy bug tracker.
  • Post a question to the Achievo/ATK forum (free account sign-up is required for posting). When posting to the forum, always include the following to help other Achievo users and developers give you the best response: ** a summary of what you are trying to achieve and symptoms of the problem (what you think is going wrong, or not happening when it should) ** your server operating system and version (e.g., FreeBSD 9.0, Ubunto 11.10, OpenSUSE 12.1, Windows 7, ...) ** your web server and version (e.g., Apache 2.2.22) ** your PHP version (e.g., PHP 5.3.10) ** your MySQL server version (e.g., MySQL 5.5.20) ** (optional) example code. Sometimes posting code is the simplest way to describe a technical problem you're having. If you are posting code, provide the simplest example that demonstrates your problem.