Fix headers
This commit is contained in:
14
readme.md
14
readme.md
@@ -1,19 +1,19 @@
|
||||
#XML Tools
|
||||
# XML Tools
|
||||
Content of this project is a service hosting tools for xml documents including xslt transformer,
|
||||
xpath selector and xsd validator.
|
||||
|
||||
##About project
|
||||
## About project
|
||||
Service is split into two microservices one containing JavaSpark web application and second hosting
|
||||
static documents.
|
||||
|
||||
##JavaSpark backend
|
||||
## JavaSpark backend
|
||||
Backend is hosted by default on port 8081. Rest api documentation is contained in OpenApi document
|
||||
openapi.yml
|
||||
|
||||
Rest API accepts xml documents, given querry and processor version to call requested xml engine to perform given
|
||||
operation and finally returns outcome in response body.
|
||||
|
||||
##Frontend
|
||||
## Frontend
|
||||
All the static files are available by default on port 8086 and are located within folder.
|
||||
|
||||
To preview given document user is required to post GET request to following path:
|
||||
@@ -24,16 +24,16 @@ Documents are hosted by docker container running on ngix image and to modify con
|
||||
one must modify Dockerfile located in Frontend folder. Files published must be located in ngix directory
|
||||
within created container.
|
||||
|
||||
##How to run
|
||||
## How to run
|
||||
|
||||
###Localy
|
||||
### Localy
|
||||
In order to run application use
|
||||
```aidl
|
||||
docker-compose up --build -d
|
||||
```
|
||||
Which will launch service on localhost.
|
||||
|
||||
###Remote
|
||||
### Remote
|
||||
To launch service on remote host, exchange ssh keys with destination server and declare docker context ex. DEV.
|
||||
Then use following command
|
||||
```aidl
|
||||
|
||||
Reference in New Issue
Block a user