Added a README that explains the folder structure

This commit is contained in:
Peter 'Pita' Martischka 2011-07-27 20:18:55 +01:00
parent fd329c189a
commit fbcfd44fe2
1 changed files with 13 additions and 0 deletions

13
node/README.md Normal file
View File

@ -0,0 +1,13 @@
# About the folder structure
* **db** - all modules that are accesing the data structure and are communicating directly to the database
* **handler** - all modules that responds directly to requests/messages of the browser
* **utils** - helper modules
# Module name conventions
Module file names starts with a capital letter and uses camelCase
# Where does it start?
server.js is started directly