Development Overview

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

Getting Started

Accounts

You must have and give to us:

• a google mail account to sign in our googlegroups:
  • ​Developers Mail Group
  • ​Users Mail Group
• if you are working for Astea Solutions, ask somebody from the team to add you to these groups as well:
  • ​Astea JR Group
  • ​Astea Everyone Group
• a Skype account
• a phone number

Ask somebody from the team to provide you with:

• a svn account
• a TRAC account

Every machine should have

• at least two users
  • for private usage - you choose your username and password
  • for public usage - ask a team member for the username and password
• a text editor (Notepad++ for example - you can download it from ​http://notepad-plus.sourceforge.net/uk/site.htm)
• a web browser (Mozilla Firefox, Chrome or Opera for example)
• a PDF reader (Adobe Acrobat for example)
• Flash player
• Skype (used for communication with the team, give your username to us)
  • download it from ​http://www.skype.com/intl/en/download/
• Sophie
  • Sophie Author - ​http://opensophie.org/en/downloads/sophieauthor
  • Sophie Reader - ​http://opensophie.org/en/downloads/sophiereader
• The hardware, software and platform requirements for running Sophie2 are listed in the Requirements page.

Technologies used

• 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 in the Development Tools section.

• 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/. You can open Trac
  • From inside the office: ​http://10.10.117.11:8000/sophie2/
  • From outside the office: ​http://asteasolutions.net:7080/sophie2/
    Help about using the Trac wiki as well as some page templates can be found under TracWiki
    Explanation of using the ticket system of the Trac can be found here: SCS_ISSUE_TRACKER_SETUP_R1

• Subversion (SVN) client. Subversion is the version control system that we use.
  • On Windows you can use TortoiseSVN
    • download: ​http://tortoisesvn.net/download
  • useful links:
    • ​http://subversion.tigris.org/ - the official site of Subversion
    • ​http://en.wikipedia.org/wiki/Concurrent_Versions_System - information about CVS
    • ​http://svnbook.red-bean.com/ - book about Subversion
    • ​http://wiki.freaks-unidos.net/Apache2%20SSL%20and%20Subversion%20in%20Debian - installing Subversion under Debian

• Maven. Maven is a build manager used in the Sophie2 project. You can dowload the latest version from ​http://maven.apache.org/download.html.
  • Note: Be careful with the PATH variable under Windows, you have to write the whole path to the bin directory not using M2_HOME variable to set the new path

Setup

• Install the subversion client (In Windows, run the .msi installer of TortoiseSVN; in Linux, follow the installation instructions linked above).
• Install Maven. Installation instructions can be found at the download page.
• Get familiar with the Repository and the Platform structure.
• Follow the instructions in the Setup section to finish the setup.

Tasks

Process

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

Performing tasks

• Writing analysis: After reading the Process page, you should know what analysis is. See the How to write analyses page for instructions on how to write a good analysis.
• Writing reports: In the end of every working day you should submit a daily report, as well as an iteration report in the end of the iteration. See the Reports page for instructions on writing reports.
• Coding - You should review the following pages:
  • Code Tasks Requirements
  • Code Smells
  • Writing Javadoc
  • Logging
• Testing
  • Manual Tests.
  • Auto Tests?.

Sophie2

Overview

You can find more information about the Sophie2 project at its introductory page.

Aspects of Sophie

• Modularity: Decomposition to plug-ins of Sophie 2 is one of the most important things to do for the project. See How to create a new module for details.
• Editions: Sophie has three main editions: Author, Reader and Server. See their structure here.
• Properties: You should read the Properties tutorial and the Code Templates page.
• Model View Controller: Core MVC.

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.
• 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 on your own. You can find help:

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

Useful Links

Important Documents.
Full Wiki index.
Other useful links

Comments

You can write your comments here.