-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,8 +5,7 @@ Ermac | |
|
|
||
| Ermac is an embeddable GUI of the [MPDS platform](https://mpds.io). It allows browsing the MPDS scientific data from any website or integrating the MPDS GUI into the existing codebases. | ||
|
|
||
|
|
||
| **WARNING!** Ermac is based on the old-style JQuery-fashioned ES5 JavaScript (see `src_js` folder). The `Node` and `npm` are intentionally **NOT** used. Several external dependencies are supplied simply along with the codebase in `third_party` and `src_js/third_party` folders. For future, we consider re-implementation of this codebase in the modular TypeScript framework. Please [contact us](mailto:[email protected]) if you'd like to know more or help. | ||
| **This is completely free software. Upon compilation it's just a few _static_ web files. Copy them to your web-server in a subfolder and enjoy your _own_ MPDS platform. The data stays at the MPDS server.** | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
@@ -16,13 +15,18 @@ An arbitrary static web-server is required, e.g. `python -m SimpleHTTPServer` or | |
| ``` | ||
| git clone https://github.com/mpds-io/ermac | ||
| cd ermac | ||
| # then run your static web-server and open example in a web-browser | ||
| # then run your static web-server and open it in a web-browser | ||
| ``` | ||
|
|
||
|
|
||
| ## Technical details | ||
|
|
||
| Ermac is just a thin browser client (with a little fat). From whatever physical location, it talks to the MPDS platform servers at the `api.mpds.io` domain. Beware, Ermac employs the old-style JQuery-fashioned ES5 JavaScript (see `src_js` folder). The `Node` and `npm` are intentionally **NOT** used. Several external dependencies are supplied simply along with the codebase in `third_party` and `src_js/third_party` folders. For future, we consider re-implementation of this codebase in the modular TypeScript framework. Please [contact us](mailto:[email protected]) if you'd like to know more or help. | ||
|
|
||
|
|
||
| ## Compilation | ||
|
|
||
| Compilation into the production bundle `ermac.min.js` from `src_js` is done via the Google Closure Compiler supplied in `third_party/jscomp` folder, see `deploy/build_js.sh` script. For that you need a Java Runtime Environment (JRE), i.e. `java -version` should not produce an error in your terminal. On a typical Unix, such as Debian, JRE is installed e.g. like this: | ||
| Compilation into the production bundle `ermac.min.js` from `src_js` is done via the Google Closure Compiler supplied in `third_party/jscomp` folder, see `deploy/build_js.sh` script. For that you need a Java Runtime Environment (JRE), i.e. a command `java -version` should _not_ produce an error in your terminal. On a typical Unix, such as Debian, JRE is installed e.g. like this: | ||
|
|
||
| ``` | ||
| apt-get -y update && apt-get -y upgrade | ||
|
|
@@ -36,7 +40,7 @@ Given your JRE works, compilation is done as follows: | |
| bash deploy/build_js.sh | ||
| ``` | ||
|
|
||
| The resulted file `ermac.min.js` is to be included into your webpage (e.g. `example_prod.html`). | ||
| The resulted file `ermac.min.js` is to be included into your webpage (see `example_prod.html`). | ||
|
|
||
|
|
||
| ## License | ||
|
|
||