Project

General

Profile

Download (1.93 KB) Statistics
| Branch: | Revision:

git_sitools_idoc / flarecast / documentation / README.txt @ master

1
SITools2 README file
2

    
3
Directories
4
	cots : project libraries
5
	documentation : project documentation
6
	database : database scripts
7
	workspace : source code
8
		- client-admin : client for administrators
9
		- client-user : client for users
10
		- client-public : client common
11
		- sitools-izpack-install : installer
12
		- fr.cnes.sitools.core : server core
13
		- fr.cnes.sitools.extensions : server extensions
14
		- fr.cnes.sitools.ext.test : server extensions for tests
15
		- org.restlet.ext.solr : Solr 3.1 Restlet extension
16
		- org.restlet.security : Restlet security extensions
17
		- sitools-build : Can be used to change the ROOT_DIRECTORY property in various build.properties files
18
		- sitools-tests-testng : selenium tests project
19
	data : data directories
20

    
21
HOW TO :	
22
	
23
HOW TO COMPILE SITOOLS
24
1 - in the core project, in the folder conf/build/properties create a file named build-<your_name>.properties 
25
2 - fill in the properties ( copy them from another build-<name>.properties )
26
3 - in the core project, in the build.properties file ( root folder ) change the HOST value. Set it to <your_name> ( HOST = <your_name>)
27
4 - run the default ant task from the build.xml file ( root folder )
28

    
29
HOW TO RUN SITOOLS
30
1 - in the core project, run the script : ./sitools start
31

    
32
HOW TO EXECUTE THE TESTS
33
1 - Compile the core
34
2 - Set up the database as described in the "DG-ULISSE.doc" document
35
3 - in the core project, run the "execute-tests" ant task from the build.xml file ( root folder )
36

    
37
HOW TO COMPILE THE EXTENSIONS
38
1 - Compile the core
39
2 - in the extensions project, run the default ant task from the build.xml file ( root folder )
40

    
41
HOW TO COMPILE THE IZPACK INSTALLER 
42
1 - Compile the core and the extensions
43
2 - In the installer project, in the build.properties ( root folder ) change the ROOT_DIRECTORY_LOCAL value. Set it to the folder containing "workspace"
44
3 - run the default ant task from the build.xml file ( root folder )
45

    
46
For more information please consult the documentation directory