https://github.com/joewiz/oxex
An oXygen project file to simplify common tasks in eXist app development
https://github.com/joewiz/oxex
Last synced: 6 months ago
JSON representation
An oXygen project file to simplify common tasks in eXist app development
- Host: GitHub
- URL: https://github.com/joewiz/oxex
- Owner: joewiz
- Created: 2018-04-19T22:46:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-23T14:04:02.000Z (over 4 years ago)
- Last Synced: 2024-04-14T22:55:42.360Z (over 1 year ago)
- Language: XQuery
- Homepage:
- Size: 26.4 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# oxex
An oXygen project file to simplify common tasks in eXist app development.
The core file is `oxex.xpr`, an oXygen project file that defines a set of entries for oXygen's [External Tools](https://www.oxygenxml.com/doc/versions/20.0/ug-editor/topics/integrating-external-tools.html) menu. Once you open the `oxex.xpr` file in oXygen, you will see a new menu in your toolbar:
These entries perform the following tasks:
- Upload the currently open file to eXist. The file is uploaded from its location on the filesystem to the corresponding location inside of `/db/apps`—the conventional location where applications installed in the eXist database. Also, you can delete the current file from eXist—all without drilling into oXygen's eXist [Data Source](https://www.oxygenxml.com/xml_editor/eXist_support.html).
- Fetch updates from the file's parent git repository. Without switching to or activating a git client.
- Build and deploy the app to eXist. Assumes your app can be built by calling its Apache Ant build.xml file that is commonly used to package applications into for [EXPath Packages](http://expath.org/spec/pkg) in the eXist community.
- Wipe the eXist database. Sometimes you just need a clean start.
- Open the current repository in commonly used apps like GitHub Desktop or Atom (pre-populating a [`.existdb.json` file](https://github.com/eXist-db/atom-existdb#automatic-sync) used by the [Atom editor package for eXist-db](https://atom.io/packages/existdb))
These commands simply pass information from oXygen to the ant scripts.
## Dependencies
- Apache Ant
- Apache Maven
To install these dependencies on macOS with [Homebrew](https://brew.sh), just run `brew install ant maven`.
## Setup
- Clone this repository to the folder where you clone your other eXist app repositories. For example, if you typically clone your repositories to your a directory in your home directory called `workspace`, you would clone oxex there too.
- Make a copy of `build.properties`, called `local.build.properties`.
- Supply the full path to your `workspace` directory in the property, `apps.home`; and supply your eXist credentials in `local.instance.user` and `local.instance.password`.
- Open the `oxex.xpr` file in oXygen, which will cause oXygen to open the Project pane with the parent directory, and which will configure an External Tools menu with oxex's commands.
- Select the "Setup oxex" command to download required libraries for interacting with eXist. This is only needed once.
- Using oXygen's project pane, open a file in one of your eXist applications (e.g., `workspace/my-app/my-file`).
- Select the "Upload current file to localhost" to upload the file to the database (e.g., `/db/apps/my-app/my-file`) (keyboard shortcut: command-u).
- Select the "Deploy current repository to localhost" to call the app's own `build.xml` file and upload and deploy the resulting `.xar` file (conventionally stored in the repo's build directory; keyboard shortcut: command-shift-u).
These functions can be called directly from the command line, but they are geared toward use from oXygen. Additional functions are contained in `build.xml`, which could be exposed if there is interest.