Familiarising With The Code Base

1 view
Skip to first unread message

Vijeenrosh PW Vijeen

unread,
Mar 4, 2012, 1:35:30 PM3/4/12
to sahan...@googlegroups.com
Hi ,
I have found it really interesting to hack the sahana eden code base . But there are some problems that have slowed down the process

1) Web2py being new to me , there is an lot of confusion going on while reading the code eg : confused about whether an function is part of the web2py framework of is it defined somewhere  else in sahanacode base .
2) source code being very large chances of not getting familiar  with required core areas are there 

* It would be an great deal of help for we newbies , if some body could point out the road map to study the code base (important files that MUST be familiarised )
  and the common functions used there in like has_module() etc so that we could have an abstract  know-how about such functions

* parts of the Web2Py where more stress is to be given 

*files which are important to eden . this will allow to have hooks on various  indepenedet source files and analyze codebase and finaly relate all those



--
Vijeenrosh P.W
CSE S4
blog :  www.BlackJackVijeen.blogspot.com



Fran Boon

unread,
Mar 4, 2012, 1:51:03 PM3/4/12
to sahan...@googlegroups.com
On 4 March 2012 18:35, Vijeenrosh PW Vijeen <hsorh...@gmail.com> wrote:
> 1) Web2py being new to me , there is an lot of confusion going on while
> reading the code eg : confused about whether an function is part of the
> web2py framework of is it defined somewhere  else in sahanacode base .

Functions with 's3' in the title are always Sahana
Other functions are mostly part of web2py.

> 2) source code being very large chances of not getting familiar  with
> required core areas are there
> * It would be an great deal of help for we newbies , if some body could
> point out the road map to study the code base (important files that MUST be
> familiarised )
>   and the common functions used there in like has_module() etc so that we
> could have an abstract  know-how about such functions

The Book is the best place to start with:
http://eden.sahanafoundation.org/wiki/Book

This covers those things which are needed for the common usecases of:
(A) Customising existing functionality
(B) Adding a new module


For deeper framework stuff then the Wiki is the best bet:
http://eden.sahanafoundation.org/wiki/DeveloperGuidelinesS3Framework

Of course, the code moves faster than the documentation, so any help
that you can provide on the documentation is welcomed :)

Best Wishes,
Fran.

Reply all
Reply to author
Forward
0 new messages