Usage with Git and Subversion
Source control system is an absolute necessity in modern software development. Depending on the type of project you might want to use either Git or Subversion. Agile Toolkit uses Git due to its open-source nature. If you are willing to add changes to Agile Toolkit, you can fork it on GitHub.com.
If you want to use the most up-to-date copy of Agile Toolkit, then you will need to use "git". Git is a command-line interface utility, which is executed as "git command arguments ..'. A good starting guide on Git is: http://book.git-scm.com.
https://github.com/atk4/atk4 is the GitHub page for Agile Toolkit. You will find a "branch" switch as well as a selection of tags. There are two major branches: "devel" and "master". All the stable releases are based on the "master" branch, while beta releases are based on the "devel" branch. Sometimes new feature branches will appear, as experimental features are being developed.
The documentation on this site applies to the 4.1 branch (or later, where specified). As the code in the project is improved, some functions might be renamed. Backwards compatibility is maintained throughout one major upgrade release, for instance: migrating 4.0 code to 4.1 probably works well and requires little change, but migrating from 4.0 to 4.2 might require you to change several calls to functions which have been made obsolete. Some older classes may be removed and placed under the "atk4-obsolete" repository. If your legacy code still relies on them, copy them into your local lib directory or, use the addLocation() method.
- https://github.com/atk4/atk4 (git://github.com/atk4/atk4.git) - Agile Toolkit
- https://github.com/atk4/atk4-addons (git://github.com/atk4/atk4-addons.git) - Agile Toolkit Addons
- https://github.com/atk4/atk4-web (git://github.com/atk4/atk4-web.git) - Sources for THIS website
- https://github.com/atk4/atk4-codepad (git://github.com/atk4/atk4-codepad.git) - Sources for http://codepad.agiletoolkit.org, which contain examples for code sharing
- https://github.com/atk4/atk4-example (git://github.com/atk4/atk4-example.git) - Contents of the default downloadable package, which is linked from http://agiletoolkit.org/
- https://github.com/agiletech/colubris (git://github.com/agiletech/colubris.git) - A real budget-tracking project developed in Agile Toolkit and released under open-source license
- Open github.com, login and create a new repository. Follow instructions.
- Remove atk4 / atk4-addons if you have downloaded them through ZIP
- Checkout atk4 and atk4-addons directly through Git
$ git submodule add email@example.com:atk4/atk4.git
$ git submodule add firstname.lastname@example.org:atk4/atk4-addons.git
$ git submodule update
- If you want the development branch:
$ cd atk4
$ git checkout devel
$ cd ..
$ cd atk4-addons
$ git checkout devel
$ cd ..
- use "git status" and create your own .gitignore file. Add "config.php", ".htaccess" and other files which you do
not wish to share to your .gitignore.
Why is placing config.php and .htaccess into Git/SVN bad?
The config.php file contains server-specific configuration. This configuration might include private keys, a mysql password or some other sensitive information. Adding this information to Git may expose it publicly on-line to people who woludn't normally have access to your server.
The ".htaccess" file might be OK for public viewing, although if you have some server-specific configuration in there, the same principle applies.
- "git add ." to add all files to your new repository
- "git push" to send your files to Github.com.
- Let us know about your project
Share Your Project
If you are developing a non-commercial project with Agile Toolkit under the AGPL license, we invite you to share this project on GitHub.