Development Overview

This page contains all the information you need in order to start working on the Sophie2 Project.

Getting Started

• The first thing to get started with is joining the mail groups and Skype group chats of Astea Solutions. See PLATFORM_INFRASTRUCTURE_OVERVIEW for details.

• The machine you are using for development should be provided with the software, described in PLATFORM_INFRASTRUCTURE_OVERVIEW.

• The hardware, software and platform requirements for running Sophie2 are listed in PLATFORM_NFR_COMPATIBILITY.

Technologies used

• Trac. This is our project management system that includes bug and issue tracking as well as an integrated wiki. The home page of the Trac project is ​http://trac.edgewall.org/. Information about using the Trac can be found under PLATFORM_INFRASTRUCTURE_OVERVIEW.

• Java Development Kit. Sophie2 is written in Java. That means you have to install Java Development Kit if you want to develop it. Java Runtime Environment (JRE) is required for running the project.

• Eclipse. Eclipse is the primary IDE tool used for developing Sophie2. More information about Eclipse and JDK can be found under PLATFORM_INFRASTRUCTURE_OVERVIEW

• Subversion (SVN) client. Subversion is the version control system that we use.

• Maven. Maven is a build manager used in the Sophie2 project.

Setup

• Subversion client. Download/Tutorial links: PLATFORM_INFRASTRUCTURE_OVERVIEW.
• Repository. Once you have installed SVN, read PLATFORM_INFRASTRUCTURE_OVERVIEW ("Checkout the project repository" paragraph) to setup the repository. The Sophie2 platform is located in trunk/sophie2-platform and its structure is described in PLATFORM_STRUCTURE.
• Eclipse
  • Download: PLATFORM_INFRASTRUCTURE_OVERVIEW.
  • Compiler Settings: COMPILER_SETTINGS.
  • Subclipse Installation: PLATFORM_INFRASTRUCTURE_OVERVIEW.
  • Maven integration: PLATFORM_INFRASTRUCTURE_OVERVIEW (the "Integration with Eclipse" paragraph).
  • Importing / Running Sophie: PLATFORM_DEPLOYMENT_BUILD_ECLIPSE.
• Maven. For installing Maven, see PLATFORM_INFRASTRUCTURE_OVERVIEW.

Tasks

Process

The PROCESS is very important in order to get into the development process. Read it very carefully.

Performing tasks

• Writing analysis: After reading PROCESS, you should know what analysis is. Manual for writing good analyses -> PLATFORM_STANDARDS_ANALYSIS_R0
• Writing reports: In the end of every working day you should submit a daily report, as well as Iteration report in the end of the iteration. How to do this: REPORTS.
• Coding
  • Code Tasks Requirements: CODE_TASKS_REQUIREMENTS.
  • Naming Conventions: NAMING_CONVENTIONS.
  • Code Smells: CODE_SMELLS. Bad code examples.
  • Writing Javadoc: JAVADOC_CONVENTIONS.
  • Logging: LOGGING.
• Testing
  • Manual Tests: PLATFORM_STANDARDS_MANUAL_TESTS_R0.
  • Auto Tests: TESTING?.

Sophie2

Overview

TODO link to Sophie intro.

Aspects of Sophie

• Modularity: Decomposition to plug-ins of Sophie 2 is one of the most important things to do for the project. PLATFORM_DEPLOYMENT_BUILD_ECLIPSE (the bottom) describes how to create a new module.
• Editions: Sophie has three main editions: Author, Reader and Server. More info here: PLUGIN_EDITIONS_STRUCTURE.
• Properties: Properties tutorial -> PRO_LIB_CORE_TUTORIAL, Property templates for Eclipse -> PRO_LIB_CORE_CODE_TEMPLATES.
• MVC: CORE_MVC_BASE.

Development issues

• Sophie Platform: the platform contains the internals from which everything visible is build.
  • Platform Design
  • Plugin Architecture
  • Core: Properties, changes, logging.
  • Base: gui libraries, persistence libraries... test helpers...
  • Features: Application/Book/In-level features. Application features: books; Book features: book contents; In-level features: frames, etc.
• Sophie Server.
• Sophie end product: Help, etc.
• Project Community: Publishing the project status.
• Supporting Artifacts: Schedule, backlogs, process, etc.

Getting Help

You will certainly encounter a problem you cannot resolve by your own. So, if you need help, you could find it:

• In our mail group (see the begining of this document);
• In our Skype group chat (again, the begining of this document);
• In the Sophie2 forum: ​http://asteasolutions.net:7080/sophie2/discussion/.

Useful Links

Sophie source can be browsed from here: ​http://asteasolutions.net:7080/sophie2/browser.
Important Documents section: ImportantDocs.
Full Wiki index: TitleIndex.
More links at USEFUL_LINKS .

Comments

Please, write below your suggestions about improvements.