{"id":18431372,"url":"https://github.com/mpds-io/ermac","last_synced_at":"2025-04-07T18:32:46.517Z","repository":{"id":41903553,"uuid":"468932582","full_name":"mpds-io/ermac","owner":"mpds-io","description":"Ermac is a standalone MPDS platform GUI to be embedded in any website","archived":false,"fork":false,"pushed_at":"2024-07-30T12:51:21.000Z","size":24408,"stargazers_count":3,"open_issues_count":8,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-07-30T16:03:48.496Z","etag":null,"topics":["materials-design","materials-genome","materials-informatics","materials-platform","materials-science","mpds-api","mpds-platform"],"latest_commit_sha":null,"homepage":"https://ermac.absolidix.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mpds-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-11T23:49:28.000Z","updated_at":"2024-07-30T12:51:25.000Z","dependencies_parsed_at":"2024-03-15T16:29:06.701Z","dependency_job_id":"e5bd042b-cd90-4351-9863-af7ac8e00491","html_url":"https://github.com/mpds-io/ermac","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpds-io%2Fermac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpds-io%2Fermac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpds-io%2Fermac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpds-io%2Fermac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mpds-io","download_url":"https://codeload.github.com/mpds-io/ermac/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223288523,"owners_count":17120406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["materials-design","materials-genome","materials-informatics","materials-platform","materials-science","mpds-api","mpds-platform"],"created_at":"2024-11-06T05:24:36.703Z","updated_at":"2024-11-06T05:24:37.282Z","avatar_url":"https://github.com/mpds-io.png","language":"JavaScript","readme":"Ermac\n==========\n\n[![DOI](https://zenodo.org/badge/468932582.svg)](https://doi.org/10.5281/zenodo.7693197)\n\n![MPDS free open-source GUI](https://raw.githubusercontent.com/mpds-io/ermac/master/ermac.png \"MPDS free open-source GUI\")\n\nErmac 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.\n\n**Ermac is completely free software. Upon compilation it's just a few _static_ web assets. Copy these files to your web-server in a subfolder and enjoy your _own_ MPDS platform. The data stays at the MPDS server.**\n\n\n## Usage\n\nAn arbitrary static web-server is required, e.g. `python -m http.server` or `php -S localhost:5555` or `npm i -g http-server \u0026\u0026 http-server` or whatever. All the content is static. In the **development mode**, the code is served from the `src_js` folder. In the **production mode**, the code in `src_js` should be compiled into a bundle `ermac.min.js`, which is then served. See `example_dev.html` and `example_prod.html` correspondingly.\n\n```\ngit clone https://github.com/mpds-io/ermac\ncd ermac\n# then run your static web-server and open it in a web-browser\n```\n\n\n## Technical details\n\nErmac 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:hello@tilde.pro) if you'd like to know more or help.\n\n\n## Compilation\n\nCompilation 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:\n\n```\napt-get -y update \u0026\u0026 apt-get -y upgrade\napt-get install default-jre\njava -version\n```\n\nGiven your JRE works, compilation is done as follows:\n\n```\nbash deploy/build_js.sh\n```\n\nThe resulted file `ermac.min.js` is to be included into your webpage (see `example_prod.html`). Alternatively, see [Ermac demo](https://ermac.absolidix.com) which is just a repository branch `gh-pages` compiled by GitHub action and served at the custom domain.\n\n\n## License\n\nMIT \u0026copy; Evgeny Blokhin, Tilde Materials Informatics\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpds-io%2Fermac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmpds-io%2Fermac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpds-io%2Fermac/lists"}