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:35:00 +02:00
parent 01a88d0f2b
commit 076e82abcd
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/DEVELOPMENT.md
View file

@ -166,10 +166,10 @@ 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
@ -189,10 +189,10 @@ The code is so divided:
| +- 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)
@ -200,9 +200,11 @@ The code is so divided:
| +- 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
Most of the time you have to edit something in angular\_app/js/ (for the logic; especially controllers.js and services.js), angular\_app/*.html (for the presentation) or eventman\_server.py for the backend.
Coding style and conventions Coding style and conventions
============================ ============================