cloudstore-developers
Details
.project 2(+1 -1)
diff --git a/.project b/.project
index 81db0ec..affb9f8 100644
--- a/.project
+++ b/.project
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
- <name>showcaseV3</name>
+ <name>CloudStore</name>
<comment></comment>
<projects>
</projects>
README.md 92(+88 -4)
diff --git a/README.md b/README.md
index 16c34ac..e06eca2 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,92 @@
-## Showcase
+## Introduction
-The showcase is e-commerce web application developed by using [TPC-W](http://www.tpc.org/tpcw/) standard and it is used to validate the tools that were developed during project. Application was developed in Java Springframework and you can find its source code in [application](https://github.com/CloudScale-Project/Showcase) directory.
+CloudStore is an open-source e-commerce web application developed following the functional requirements defined by the [TPC-W](http://www.tpc.org/tpcw/) standard, and it's goal is to be used for the analysis of cloud characteristics of systems, such as capacity, scalability, elasticity and efficiency. It was developed as a Showcase application to validate the CloudScale tools that were developed during that project.
+
+The application was developed in Java using the Spring framework and running on a Tomcat web application server, while using a MySQL database.
+Static files and images needs to be generated with ImgGen tool, but a default database dump and load generation scripts are available in order to start testing a deployment in a very short time.
+
+Different IaaS, PaaS, Storages and Architectures can be tested with little one little changes to the code.
+
+## Deployment
+
+To deploy CloudStore on public or private cloud you can use our [deployment scripts](https://github.com/CloudScale-Project/Deployment-Scripts). We have also developed the [distributed JMeter](https://github.com/CloudScale-Project/Distributed-Jmeter) scripts in order to load test the CloudStore.
+
+## Database
+
+CloudStore is using MySQL database. Database can be generated by running ```Generate.java``` file:
+
+```
+$ cd src/main/java/eu/cloudscale/showcase/generate/
+$ javac Generate.java
+$ java Generate mysql
+```
+
+This takes a long time and it's slow. We recommend you to import [SQL dump](http://cloudscale.xlab.si/showcase/dumps/rds-tpcw-dump-latest.sql) into your MySQL database.
+
+## Running
+
+For running CloudStore on your computer you will need Tomcat and MySQL database installed.
+You can also import and run CloudStore from Eclipse IDE.
+Before you can run CloudStore on Tomcat you will need to compile it into ```.war``` archive. Before compiling the CloudStore edit some config files.
+
+### Configs
+With config files you tell CloudStore where it can find the images and how to connect to database.
+
+##### src/main/resources/app.properties
+In this file set the url for CSS, JavaScript and image files:
+
+```eu.cloudscale.files.url.css``` - URL to the folder with CSS files
+
+```eu.cloudscale.files.url.img``` - URL to the folder with image files
+
+```eu.cloudscale.files.url.js``` - URL to the folder with JavaScript files
+
+#### src/main/resources/database/database.aws.hibernate.properties
+In this file configure the MySQL database:
+
+```jdbc.driverClassName``` - Set to ```com.mysql.jdbc.ReplicationDriver``` if you want to use master-slave MySQL setup. Otherwise set it to ```com.mysql.jdbc.Driver``` value.
+
+```jdbc.url``` - Connection URL to the host and database. Format is ```jdbc:mysql://<host>/<database_name>```.
+
+**Note:**
+If you want to use master-slave MySQL setup use ```jdbc:mysql:replication://``` format, otherwise ```jdbc:mysql://```.
+
+```jdbc.username``` - Username to connect to database
+
+```jdbc.password``` - Password for the user to connect to database
+
+```jdbc.hibernate.dialect``` - Hibernate dialect
+
+### Compiling
+CloudStore is a Maven project so you will have to install the Maven tool.
+
+When you installed Maven you can compile CloudStore into ```war``` archive with executing the following command:
+
+```bash
+$ mvn clean install
+```
+
+from directory where the ```pom.xml``` file is located.
+
+### Installing
+Copy ```target/showcase-1.0.0-BUILD-SNAPSHOT.war``` to Tomcat.
+
+## Using ImgGen tool
+Open file ```populate_images``` and edit:
+
+```$NUM_ITEMS``` - How many items/books are in database (default: 10000)
+
+```$DEST_DIR``` - Directory name where to save generated images
+
+```$GEN_CMD``` - Path to ```tpcwIMG``` program for generating the images (default: ImgFiles/tpcwIMG)
+
+Now run command:
+
+```
+$ ./populate_images
+```
+
+Copy the directory with images to somewhere publicly available.
-We also developed [deployment scripts](https://github.com/CloudScale-Project/Deployment-Scripts) to deploy showcase on Amazon Web Services public cloud and on OpenStack private cloud. In order to load test application we developed [distributed JMeter](https://github.com/CloudScale-Project/Distributed-Jmeter) application which helps us deploying distributed JMeter on Amazon Web Services or on OpenStack.
-In this repository you will also find the [response generator](https://github.com/CloudScale-Project/Response-Generator) application which we use to simulate the payment gateway of showcase application.