diff ikweb/README @ 247:7747bbe5b68e

start to develope Information Exchange Center of Ikariam Game. (prototpye)
author "Hisn Yi, Chen <ossug.hychen@gmail.com>"
date Mon, 01 Dec 2008 00:27:22 +0800
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ikweb/README	Mon Dec 01 00:27:22 2008 +0800
@@ -0,0 +1,57 @@
+Definition
+
+    * GAE: Google App Engine
+    * GAEO: Google App Engine Oil ( Web Framwork )
+
+Requirment Of Develope Env
+
+    * download eagle-eye and setup it. see more in eagel-eye README
+    * download GAE SDK and setup it.
+    * download GAEO Framwork and setup it. see more in GAEO document.
+
+    * add following in ~/.bashrc
+
+        export GAEO_HOME='~/codes/gaeo'  # put your installation directory here.
+        export GAE_HOME='~/codes/google_appengine'
+        PATH=$PATH:$GAEO_HOME/bin:$GAE_HOME:~/bin/ 
+
+Launch Web site
+
+    * using GAE dev_server.py to launch.
+    * browse http://localhost:8080 to see the index page.
+
+Develope new version of models if chichchun has changed database schema.
+
+    if db schema has changed, the GAEO models in web site need to rebuild,
+    a model generator will get colum informations in all tables in ikariam.sqlite, 
+    and makes new GAEO models, which has a required properties, you may want to 
+    modify it later if some properties is wrong.
+
+    the model relation will not generate in this action, you have added it by hand.
+
+    [ WARRING ]
+    it will re-generate all models, the web site can not work until
+    you have done the work that re-design models.
+
+    $ ./rebuild_world
+    
+How many model are implemented already?
+ 	
+ 	player, island, city, ally
+    
+How to kwnow What input fileds of the model in POST ?
+ 
+ 	use action "attrs", example: http://localhost:8080/player/attrs
+
+How to display model information ?
+
+	use action "show", example: http://localhost:8080/player/show/1
+
+	p.s the last number 1 is the Ikariam Game ID of the model.
+
+Hot to get the datas of the model in JSON formate?
+
+	use action "json", example: http//"localhost:8080/player/json/1"
+	
+	p.s the last number 1 is the Ikariam Game ID of the model.
+ 	
\ No newline at end of file