Developer Guide

Zanata Developer Guide

• JBoss AS 7

Development tools

• Java Development Kit (JDK) 1.6 - yum install java-1.6.0-openjdk-devel
• GIT - Source code repository
• Eclipse IDE for J2EE (Kepler 4.2)
• MySQL database
• JBoss AS 7.2 (EAP 6.1)
• Maven v3

Code style (for new files)

NB: Please don't reformat existing files: we want to do them all at once to keep the history manageable.

General:

• NO TABS!
• line width: 80 (allows side-by-side diffs) (NB: IDEA formatters use the same length for all file types)

Java, Groovy code:

• 4 space indent
• cuddle braces

JavaScript code:

• 2 space indent
• cuddle braces

XML/XHTML/CSS/XML:

• 2 space indent
• format comments, but don't join lines
• insert whitespace before closing empty end-tags
• don't let IDEA align attributes (Eclipse formatter doesn't have this option)

TODO: find some existing (standard) Eclipse code formatter profiles and link to them.

Zanata Developer Setup Guide

1. install JDK 1.6 (see above)
2. install git
3. get Zanata source GitHubSetup
4. install Maven
5. install MySQL client and server
6. create database: zanata
7. install JBoss
8. configure JBoss
9. add MySQL JDBC driver to JBoss
10. add Zanata datasource to JBoss
11. add mysql and JBoss details to maven settings
12. install Eclipse
13. add Eclipse plugins
14. prepare zanata for eclipse import
15. import zanata into eclipse
16. configure Eclipse

Zanata Architecture Overview

See Architecture