alberanid/eventman
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

update documentation

Browse source
This commit is contained in:
Davide Alberani 2016-07-10 17:27:31 +02:00
parent 82cdbf6738
commit 3e1d6e987e
1 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
docs/DEVELOPMENT.md
View file

@ -165,42 +165,42 @@ Code layout
=========== ===========
The code is so divided: The code is so divided:
+- eventman\_server.py - the Tornado Web server +- eventman\_server.py - the Tornado Web server
+- backend.py - stuff to interact with MongoDB +- backend.py - stuff to interact with MongoDB
+- utils.py - utilities +- utils.py - utilities
+- angular\_app/ - the client-side web application +- angular\_app/ - the client-side web application
| | | |
| +- *.html - AngularJS templates | +- *.html - AngularJS templates
| +- Gruntfile.js - Grunt file to extract i18n strings | +- Gruntfile.js - Grunt file to extract i18n strings
| +- js/*.js - AngularJS code | +- js/*.js - AngularJS code
| | | |
| +- app.js - main application and routing | +- app.js - main application and routing
| +- controllers.js - controllers of the templates | +- controllers.js - controllers of the templates
| +- services.js - interaction with the web server | +- services.js - interaction with the web server
| +- directives.js - stuff to interact with the DOM | +- directives.js - stuff to interact with the DOM
| +- filters.js - filtering data | +- filters.js - filtering data
| +- i18n.js - i18n | +- i18n.js - i18n
+- data/ +- data/
| | | |
| +- triggers/ | +- triggers/
| | | |
| +- triggers-available/ - various trigger scripts | +- triggers-available/ - various trigger scripts
| +- triggers/ enabled trigger scripts | +- triggers/ enabled trigger scripts
| | | |
| +- attends.d/ - scripts to be executed when a person is marked as an attendee | +- attends.d/ - scripts to be executed when a person is marked as an attendee
| +- create\_ticket\_in\_event.d/ - scripts that are run when a ticket is created | +- create\_ticket\_in\_event.d/ - scripts that are run when a ticket is created
| +- update\_ticket\_in\_event.d/ - scripts that are run when a ticket is updated | +- update\_ticket\_in\_event.d/ - scripts that are run when a ticket is updated
| +- delete\_ticket\_in\_event.d/ - scripts that are run when a ticket is deleted | +- delete\_ticket\_in\_event.d/ - scripts that are run when a ticket is deleted
+- ssl/ - put here your eventman\_cert.pem and eventman\_key.pem certs +- ssl/ - put here your eventman\_cert.pem and eventman\_key.pem certs
+- static/ +- static/
| | | |
| +- js/ - every third-party libraries (plus eventman.js with some small utils) | +- js/ - every third-party libraries (plus eventman.js with some small utils)
| +- css/ - third-party CSS (plus eventman.css) | +- css/ - third-party CSS (plus eventman.css)
| +- fonts/ - third-party fonts | +- fonts/ - third-party fonts
| +- images/ - third-party images | +- images/ - third-party images
| +- i18n/ - i18n files | +- i18n/ - i18n files
+- templates/ - Tornado Web templates (not used +- templates/ - Tornado Web templates (not used
+- tests/ - eeeehhhh +- tests/ - eeeehhhh
Coding style and conventions Coding style and conventions