source: extensions/jiwigo/trunk/install/install.txt @ 6963

Revision 6963, 3.0 KB checked in by mlg, 9 years ago (diff)

Add unit tests :
New unit tests for the services :

  • CategoryServiceTest that tests the listing of the categories and the creation of a category
  • ServicesTest that tests the listing of the categories, then the listing of images of a category and finally adding a comment to an image.

Add informations in the install.txt file to explain how to build the executable jar file via maven (this allows to execute the tests before building, and does not build if tests fail).

Line 
1#####################################################################################
2
3                                                        Installation for eclipse
4
5#####################################################################################
6
71 - You must first checkout the project from svn. Create a new Java project from the svn version.
82 - Then install maven plugin for eclipse. It is available from that update site : http://m2eclipse.sonatype.org/sites/m2e
93 - Then enable maven dependency management : right click on the project > maven > enable dependency management.
104 - Now you must tell eclipse which folders are sources folders : right click on the project > properties > java build path
11> tab "Source" > Add folder. Select java and resources in main and test folders.
125 - install maven on your computer. You can download it here : http://maven.apache.org/download.html. For debian/ubuntu,
13maven is available via apt-get : sudo apt-get install maven2 (maybe for other distributions too, I did not search).
146 - Some dependency are not available from maven repositories. You must install them manually in your local repository :
15Create a new "External tool configuration" type "Program". In "Location" put the location of maven's executable. If you've
16downloaded maven via the link above, the executable is in the bin directory of the extracted folder. It is called "mvn" for
17Unix systems and mvn.bat for windows. If you've installed maven via a package manager (like apt-get), maven location will
18probably be "/usr/bin/mvn". In the argument field, put one of the two commands of the file "mvn-commands.txt". Run the command.
19If you get an error that tells you that the project location cannot be found, click on the project and run the command again.
20Replace the content of the field "argument" by the other command of the "mvn-commands.txt" file.
217 - create a new "External tool configuration" type "Program". In location put the maven executable again, in working directory,
22put "${project_loc}" and in argument put "clean eclipse:eclipse". Run the command.
23
24The project should not contain errors after that, and you should be able to launch jiwigo by launching the main class :
25src/main/java fr.mael.jiwigo.Main
26
27If you want to build an executable jar from the sources, I recommend to use a maven command : create a new "External tool configuration"
28type "Program" in location put the maven executable in working directory put "${project_loc}" and in argument put "assembly:assembly".
29Execute the command. The reason to use this command is that it launches the tests of the project and does not build a jar if the
30tests fail. It creates two jar in the "target" directory of the project : Jiwigo-version.jar and Jiwigo-version-jar-with-dependencies.jar.
31The first one is not usable because it contains only the class file of the project. The second one can be executed because
32it contains the dependencies of the project.
33
34Enjoy.
35
36I do not use other IDE, so I don't know how to install the project with other IDE. Feel free to complete this file if you know.
Note: See TracBrowser for help on using the repository browser.