Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.94 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.94 KB
Raw

Witsml Explorer Desktop Edition

Witsml Explorer Desktop Edition is an easy-to-install version of Witsml Explorer. However, this edition does not support all features as the web application.

⚠️ Please be aware that there is a potential risk associated with running jobs while using the desktop edition: As the API is running locally on your machine, there is a potential risk that critical jobs may not be able to finish. This could be due to exiting the application while running a job, computer shutdown, power outage or any other cause that forces the computer or application to shut down.

Supported operating systems

  • Windows 64-bit

Configuration

A configuration file is created in %AppData%\Roaming\WEx-Desktop\config.json. It can be edited to change the API port and the path of logging and database files.

For developers

Install dependencies:

cd Src/WitsmlExplorer.Desktop/
# Download dependencies
yarn

Run in developer mode:

# From Src/WitsmlExplorer.Desktop/ run:
yarn dev

Run production preview:

# From Src/WitsmlExplorer.Desktop/ run:
yarn preview

Build an installer and install it on your computer:

# From Src/WitsmlExplorer.Desktop/ run:
yarn electron:dist

The installer can be found in Src/WitsmlExplorer.Desktop/dist/WExDesktopInstaller.Windows.x64.<version>.exe. Run it and follow the instructions.

Run playwright tests:

# From Src/WitsmlExplorer.Desktop/ run:
yarn electron:pack
yarn test:pack

# Debug tests interactively:
yarn test:pack --debug

API log files for debugging

Check the Configuration file to see where the logging files are placed.

Releasing New Version

To release a new version of Witsml Explorer Desktop Edition, follow these step-by-step instructions:

  1. First, bump the version number in Src\WitsmlExplorer.Desktop\package.json to match the version in the tag you will create in step 2. Merge in the changes to the main branch.
  2. Create a new tag to mark the specific point in the project's history you want to release. You can use the following command:
# Create tag
git tag -a wex-desktop@<version> -m "<message>"

# Push the tag to origin
git push origin wex-desktop@<version>

  1. Merge the main branch into the stable-desktop-wex branch to keep the current released version in its own branch.

  2. Go to our GitHub page and navigate to Actions. Run the Release Desktop Edition action and use workflow from the main branch and type in the <tag_name> you used in step 1.

  3. It's also a good idea to improve the release notes. You can do this from the releases page. Click the edit button and add the necessary notes for this release.