Get started

Edirom-Online Backend is the backend for the Edirom-Online software. It is a web application written in XQuery, and is designed for deployment in eXist-db. Its development is closely connected to the Edirom-Online Frontend and the Edirom-Online as a whole. Please see the GitHub repository for Edirom-Online for planning information, issue listings, and further documentation.

Cloning this repository

bash git clone <project url>

Building locally

For building the Edirom-Online Backend you need ant installed on your system. When you have ant installed, just go into the cloned repository and type

bash ant

Starting an Edirom instance locally

• prepare exist-db
  • also see exist-db via Docker
  • docker run -it -d -p 8080:8080 -p 8443:8443 --name exist stadlerpeter/existdb:6 (see stadlerpeter/existdb)
  • open in browser: http://localhost:8080 (Note: there were problems opening this in Safari)
  • Login with "admin:[empty]"
• build and deploy xar of Edirom-Online Backend
  • also see [building locally] above
  • at http://localhost:8080/exist/apps/dashboard/admin# (signed-in) go to "Package Manager" then "Upload" and select the xar file which (supposed above build-method was used) was built at /PATH_TO_LOCAL_EDIROM_REPO/build-xar/Edirom-Online-Backend-1.0.1-[TIMESTAMP].xar
• build and deploy xar of Edirom-Online Frontend
  • for building the frontend module please see https://github.com/Edirom/Edirom-Online-Frontend
  • at http://localhost:8080/exist/apps/dashboard/admin# (signed-in) go to "Package Manager" then "Upload" and select the xar file which (supposed above build-method was used) was built at /PATH_TO_LOCAL_EDIROM_REPO/build-xar/Edirom-Online-Frontend-1.0.1-[TIMESTAMP].xar
• build xar of sample data for deploying at exist-db
  • also see building sample data
  • at http://localhost:8080/exist/apps/dashboard/admin# (signed-in) go to "Package Manager" then "Upload" and select the xar file which (supposed above build-method was used) was built at /PATH_TO_LOCAL_EDIROM_EDITION_EXAMPLE_REPO/build/EditionExample-0.1.xar
• in eXist-db Package Manager click on the "Edirom Online Frontend" entry - you will be directed to the running Edirom at http://localhost:8080/exist/apps/Edirom-Online-Frontend/index.html

Documentation

Some useful information regarding documentation is captured in the docs folder of the Edirom-Online repo. It contains: * Customize Edirom Online and content * Edirom Online – Release Workflow * Setup Edirom Online on a local machine * a data creation workflow for the Edirom-Online

Dependencies

Edirom-Online Backend depends on the following libraries:

• ./.

Roadmap

Versions of this software are planned in Edirom-Online milestones. Plans include the specification of an OpenAPI definition for the backend, and thus the refactoring to support REST requests to the backend.

Contributing

After all this information, you decided to contribute to Edirom-Online Backend, that is awesome! We prepared a CONTRIBUTING file to help start your Edirom-Aventure now.

If you encounter a security issue in the code, please see the Security Policy for further guidance.

Get in touch

Even if you are not ready (yet) to contribute to this wonderful project, maybe instead you just have a question or want to get to know the people involved in the project a little better, here are some ideas for you: * there is an Edirom mailinglist with the option for selfsubscription, we send invitations to the community meetings via this list and we have Edirom related discussions on this list * the edirom community is meeting regularly every month at the first wednesday of a month, see the wiki for more information and meeting minutes * start a discussion at GitHub Discussions

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Citation

Please cite the software/repository using the information provided under "Cite this repository" on the right hand side. The APA and BIBTeX citations are fed by information from the CITATION.cff file in this repository which you can also use as a source. If you intend to cite unreleased branches or commits please use the commit hash in the citation.

License

Edirom-Online Backend is released to the public under the terms of the MIT open source license.