Menu ▾ ▴

Home

Hammad Rauf

Instructions on Compiling and Building

Subversion source code (SVN Repo) is not being updated. Latest changes will be uploaded in the Git Code Repository (Git Repo)

For instructions on Compiling and Building please see below.

JavaDocs (API documentation) is not completed but whatever exists, it is included in source.

<<<<< If you wish to contribute in developing(programming for) this project and have some ideas to take it further, then please send me a message, I will add you as a member. Thanks.  - Hammad Rauf >>>>>>

Building and Compiling (Subversion source code - Apache Ant build)

Requirements for Compiling

  1. JDK 1.6 or JDK 1.7 (Download JDK from Oracle Website)
  2. Apache Ant (Download from Apache Ant Website) or NetBeans IDE 7.3.1 (Download from Oracle http://www.netbeans.org website)
  3. HRUtils Project source code or JAR file (This is also available on SourceForge.net, over here
  4. A text editor or NetBeans IDE 7.3.1 (For editing the location of HRUtil project location on your system)
  5. Apache Subversion (SVN) client (Download from Apache SVN website)

Requirements for Running the Server App

  1. Java (JRE) 1.6 or 1.7
  2. Apache Tomcat Server 7.0.33
  3. MySQL Database Server (5.x)
  4. Running the included database script to create the database structures and user-id

How to Compile

  1. Checkout the SchoolWeb project to folder in your system (For Example: c:\SchoolWeb).

    2. Use SVN client to checkout the source code from the SVN repository location given below (Replace LocalFolderName with your folder name):

    svn checkout svn://svn.code.sf.net/p/schoolhomework/code-0/ LocalFolderName

  2. Checkout the HRUtils project to folder in your system (For Example: c:\HRUtils)
  3. Edit the 2 files under the folder "c:\SchoolWeb\.nbproject" that point to the project location of HRUtils project to the correct value for your system
  4. Change directory to "c:\SchoolWeb" folder and type "ant" to start the compilation process, The WAR file will be written in "c:\SchoolWeb\dist" folder. This WAR file can be deployed on the Tomcat Server
  5. OR Alternatively to previous 2 steps, you can use NetBeans IDE 7.3.1 to edit the project properties (for HRUtils location) and then build and test run. To edit the project properties:
    1. Open NetBeans and open the SchoolWeb project from your system.
    2. Right click "StrutsSchoolWeb" project from the Project view and select "Properties" from the pop-up.
    3. In the "Categories" View select "Build > Packages". On the right hand side under "WAR content", use "Remove" Button to remove the old (invalid for your system) reference to HRUtils Project. Then use "Add Project" or "Add Library" button to locate and refer to HRUtils project on your system.
    4. From the "Run" menu use "Run Project" or "Build Project" as required.

External Libraries

This project uses following external libraries. Some require a license for commercial and non open source use.

  1. iTextPDF (Requires purchase of license for non open-source use)
  2. Apache Struts2
  3. Apache Tiles
  4. Spring 3.0 Framework
  5. Apache Log4J
  6. Oracle MySQL Database (Community Edition)
  7. Java Persistence Framework (ORM) - EclipseLink
  8. Java Persistence Framework (ORM) - Hibernate (Not utilized)
  9. JUnit from http://junit.org
  10. Base64, included in source code, from http://iharder.net/base64
  11. PDFRenderer from https://java.net/projects/pdf-renderer (Not utilized)
  12. PDFJS (JavaScript library and source code)

Disclaimer

This software and the web-site created by hosting this software, is free for use, on an as-is no guarantee or liability basis. If you like it then please feel free to use the source code or the created web-site services.

MongoDB Logo MongoDB