https://github.com/rjz/spark-achilles

AJAX request framework for Codeigniter
https://github.com/rjz/spark-achilles

Last synced: 17 days ago
JSON representation

AJAX request framework for Codeigniter

• Host: GitHub
• URL: https://github.com/rjz/spark-achilles
• Owner: rjz
• Created: 2011-09-16T22:02:19.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2011-12-02T18:02:07.000Z (about 13 years ago)
• Last Synced: 2024-10-22T12:07:18.113Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 122 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
achilles

========

achilles is an experimental framework for describing dynamic (AJAX) responses on the server. It's currently available as [a spark](getsparks.org/packages/achilles/versions/HEAD/show) for Codeigniter.

Want to [contribute](http://rjzaworski.com/projects/achilles/docs/ref_contribute)?

Loading the spark

---------------

	// load achilles

	$this->load->spark('achilles/0.1.1');

	

	// (optional) load achilles helper functions

	$this->load->helper('achilles_helper');

	

	// (optional) load achilles library

	$this->load->library('achilles_lib');

Documentation

-------------

Documentation and examples are available [here](http://rjzaworski.com/projects/achilles)

Contributing

------------

Please contribute! To add library routines or modify the core, please fork [achilles on Github](https://github.com/rjz/Spark-achilles) and submit your changes as a [pull request](http://help.github.com/send-pull-requests/).

## Contributing javascript handlers

To keep style consist, please make sure that contributed handler functions are:

1. added alphabetically to `js/achilles.lib.js`

2. described using [Closure-style](code.google.com/closure/compiler/docs/js-for-compiler.html) annotations

## Contributing Codeigniter routines

To ensure consistent style, please make sure that contributed routines are:

1. added alphabetically to `libraries/achilles_lib`

2. described using [PHPDoc-style](http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html) tags.

Author

------

RJ Zaworski 

License

-------

achilles is released under the JSON License. You can read the license [here](http://www.json.org/license.html).