Skip to content

Latest commit

 

History

History
103 lines (67 loc) · 3.57 KB

README.md

File metadata and controls

103 lines (67 loc) · 3.57 KB
Raw

ARCitect

The ARCitect is a cross-platform app to create and manage your ARCs and synchronize them with the DataHUB.

Installation

To install ARCitect, navigate to the releases page, and from Assets download the appropriate installer for your operating system. Open the installer and follow the instructions.

  • Windows: ARCitect-x.x.xx-win.zip

  • MacOS ARCitect-x.x.xx-universal.dmg

  • Linux: ARCitect-x.x.xx.AppImage

    Installation on Linux might require additional steps

    Install Git dependencies

    ARCitect depends on git and git-lfs. Please follow the linked guides for installation.

    Make the ARCitect installer executable

    (A) with the user interface
    • right-click the file and select properties
    • go to the "permissions" tab and tick the field "execute"
    • now double-clicking the AppImage should start the ARCitect
    (B) from the command line (you might need specific rights for this)
    • open a terminal
    • move to the directory where you have saved your AppImage (e.g. Downloads)
    cd Downloads
    • make the file executable (use the appropriate name of the file)
    chmod u+x ARCitect-x.x.xx.AppImage
    • now double-clicking the AppImage should start the ARCitect

💡 For more detailed instructions and ARCitect QuickStarts, please checkout the DataPLANT Knowledge Base.

Building from source

To build ARCitect from source you need to have Node.js, Git and Git LFS installed first.

  1. Clone this repository and install its dependencies via npm
git clone https://github.com/nfdi4plants/ARCitect
cd ARCitect
npm install
  1. Start the app in debugging mode
npm start
  1. (optional) Compile the app for your operating system
npm run compile # for linux
npm run compilew # for windows
npm run compilem # for mac

The compiled installer is created in dist/.

Contribution

The following quick guide is intended to help content contributors find a starting point.

Issues

Feel free to raise an issue to let us know what feature is missing or if anything is buggy.

Pull requests welcome

Please feel free to propose changes and fixes via pull requests. ARCitect builds on ARCtrl and integrates Swate. So please check out these repositories as well.

Release

  1. Increase package.json semver.
  2. Commit and push any changes!
  3. Any commit with release tag git tag <Placeholder>, where <Placeholder> must be equal to package.json version, will trigger release pipeline in GitHub actions.
  4. Push tag with git push origin <Placeholder>.

Help texts

Changes to the help texts can be adjusted in the corresponding document located in the following folder:

packages/renderer/src/docs

Images

Relevant images can be placed in the following folder:

packages/renderer/assets

💡 Images currently occupy 100% of the width of the help text window.