From fbcfd44fe2ea0eb83652d9c03b4b9bc74ebd85f1 Mon Sep 17 00:00:00 2001 From: Peter 'Pita' Martischka Date: Wed, 27 Jul 2011 20:18:55 +0100 Subject: [PATCH] Added a README that explains the folder structure --- node/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 node/README.md diff --git a/node/README.md b/node/README.md new file mode 100644 index 00000000..031810f6 --- /dev/null +++ b/node/README.md @@ -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