Skip to content

Commit

Permalink
IVIS-46: Fix quick_start.
Browse files Browse the repository at this point in the history
  • Loading branch information
RuslanPopenko committed Dec 2, 2016
1 parent f52e526 commit 8904cfc
Show file tree
Hide file tree
Showing 12 changed files with 183 additions and 2,540 deletions.
2,364 changes: 0 additions & 2,364 deletions docs/files/dump_db_ivis_info.sql

This file was deleted.

90 changes: 0 additions & 90 deletions docs/files/import.sql

This file was deleted.

Binary file added docs/images/imcmsClientStartPage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/oepClientStartPage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/quick_start/installation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Software Installation
=====================
======================

Process will be describe in Ubuntu Terminal (Ctrl+Alt+T), and all following code you need input there.
Process will be described in Ubuntu Terminal (Ctrl+Alt+T), and all following code you need input there.

Install Git
~~~~~~~~~~~
Expand Down
86 changes: 86 additions & 0 deletions docs/quick_start/walkthrough_install_imcms_client.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
Walkthrough: Install Imcms based client application
===================================================

Prerequisites
-------------

First of all you need install iVIS server. Visit `this page </en/latest/quick_start/walkthrough_install_ivis_server.html>`_
for details. When you have working iVIS server we can continue, but to make it possible to communicate with the iVIS
Server from the client application you need to register your client application inside the iVIS Server.
Here is the `walkthrough </en/latest/quick_start/walkthrough_ivis_server_conf.html>`_ that describes this process.

This client is based on `imCMS <http://docs.imcms.net>`_.

Git configuration
-----------------

Clone project from GitHub repository:

.. code-block:: bash
cd /../directory #Directory where project folder with content must be placed
git clone https://github.com/imCodePartnerAB/iVIS-imCMS-Client-Sample.git
After cloning will created subdirectory iVIS with content.

Database configuration
----------------------

In the Terminal (Ctrl+ALt+T) execute following commands to create the database:

.. code-block:: bash
mysql -u {username} -p{password} #{username} - database username, {password} - database password
CREATE DATABASE db_ivis_info;
Download file `dump_db_ivis_info.sql <https://github.com/imCodePartnerAB/iVIS-imCMS-Client-Sample/releases/download/v1.0.0-alpha1/dump_db_ivis_info.sql>`_
from release on Github.

In the Terminal (Ctrl+ALt+T) execute following command to run dump file on created DB:

.. code-block:: bash
mysql -u {username} -p{password} db_ivis_info < /home/downloads/dump_db_ivis_info.sql #file location after downloading
Edit file **local.server.properties** from project directory in the next way:

* User [#]_;
* Password [#]_;
* JdbcUrl [#]_;
* Hibernate.hbm2ddl [#]_;
* Hibernate.dialect [#]_;
* Server.name [#]_;

.. [#] **username** of database (default *root*)
.. [#] **password** of database
.. [#] consist of **jdbc:{provider}://{hostname}:{port}/{databaseName}?{encoding}**
for mysql {provider} = *mysql*, {hostname} = *localhost*, {port} = 3306, {encoding} = *utf-8*
Run application
---------------

.. important::
iVIS Server must be installed from `this </en/latest/quick_start/walkthrough_ivis_server_conf.html>`_ guide.

In the Terminal (Ctrl+ALt+T) execute following commands:

.. code-block:: bash
cd /../iVIS-imCMS-Client-Sample #path to project from Github
mvn tomcat7:deploy #deploy configured to localhost:8080/imcmscl.
Type http://localhost:8080/imcmscl in browser.

Input Login=admin and Password=pass.

If you see this image, everything is good, congratulations!

.. image:: /images/imcmsClientStartPage.png





77 changes: 0 additions & 77 deletions docs/quick_start/walkthrough_install_imcms_client_demo.rst

This file was deleted.

2 changes: 2 additions & 0 deletions docs/quick_start/walkthrough_install_ivis_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ In the Terminal (Ctrl+ALt+T) execute following commands:
cd /../iVIS #path to iVIS project directory
cd ivis-server
mvn tomcat7:deploy #deploy configured to localhost:8080.
Type http://localhost:8080 in browser.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Walkthrough: Install iVIS Server Client Applications
.. toctree::
:titlesonly:

walkthrough_install_imcms_client_demo
walkthrough_install_oep_client_demo
walkthrough_install_imcms_client
walkthrough_install_oep_client
89 changes: 89 additions & 0 deletions docs/quick_start/walkthrough_install_oep_client.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
Walkthrough: Install OeP based Client application
=================================================

Prerequisites
-------------

First of all you need install iVIS server. Visit `this page </en/latest/quick_start/walkthrough_install_ivis_server.html>`_
for details. When you have working iVIS server we can continue, but to make it possible to communicate with the iVIS
Server from the client application you need to register your client application inside the iVIS Server.
Here is the `walkthrough </en/latest/quick_start/walkthrough_ivis_server_conf.html>`_ that describes this process.

This client is based on `OeP <http://www.oeplatform.org>`_.

Git configuration
-----------------

Clone project from GitHub repository:

.. code-block:: bash
cd /../directory #Directory where project folder with content must be placed
git clone https://github.com/imCodePartnerAB/iVIS-OeP-Client-Sample.git
After cloning will created subdirectory iVIS with content.

Database configuration
----------------------

In the Terminal (Ctrl+ALt+T) execute following commands to create the database:

.. code-block:: bash
mysql -u {username} -p{password} #{username} - database username, {password} - database password
CREATE DATABASE db_open_platform;
Download file `dump_db_open_platform.sql <https://github.com/imCodePartnerAB/iVIS-OeP-Client-Sample/releases/download/v1.0.0-alpha1/dump_db_open_platform.sql>`_
from release on Github.

In the Terminal (Ctrl+ALt+T) execute following command to run dump file on created DB:

.. code-block:: bash
mysql -u {username} -p{password} db_open_platform < /home/downloads/dump_db_open_platform.sql #file location after downloading
Edit file **config.xml** from *demo.oeplatform.org/src/main/webapp/WEB-INF* subfolder in the next way:

* <Username>${username}</Username> [#]_;
* <Password>${password}</Password> [#]_;
* <Url>${jdbc-url}</Url> [#]_;

.. [#] **username** of database (default *root*)
.. [#] **password** of database
.. [#] consist of **jdbc:{provider}://{hostname}:{port}/{databaseName}?{encoding}**
for mysql {provider} = *mysql*, {hostname} = *localhost*, {port} = 3306, {encoding} = *utf-8*
Run application
---------------

.. important::
iVIS Server must be installed from `this </en/latest/quick_start/walkthrough_ivis_server_conf.html>`_ guide.

In the Terminal (Ctrl+ALt+T) execute following commands:

.. code-block:: bash
cd /../iVIS-OeP-Client-Sample #path to project from Github
mvn clean install
cd demo.oeplatform.org
mvn tomcat7:deploy #deploy configured to localhost:8080/oepcl.
Type http://localhost:8080/oepcl in browser.

Click "Logga in".

Input Login=admin and Password=pass.

If you see this image, everything is good, congratulations!

.. image:: /images/oepClientStartPage.png





3 changes: 0 additions & 3 deletions docs/quick_start/walkthrough_install_oep_client_demo.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/quick_start/walkthrough_ivis_server_conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ URL for access token or authorization code response.
Roles
~~~~~

Role (roles) that consist from set of permission for API access.
Role (roles) that consist from set of permissions for API access.

Described next at `Create or edit iVIS role`_ .

Expand Down Expand Up @@ -116,7 +116,7 @@ Permission represents as method API with detail description.

.. tip::
Checkbox near entity name has three state. It indicates that in group checked no one/all/some.
Also it provides possibility check/uncheck all permissions in group.
Also it provides possibility to check/uncheck all permissions in any group.



Expand Down

0 comments on commit 8904cfc

Please sign in to comment.