Swate

Swate - something or someone that gets you absolutely joyed (Urban dictionary)

Swate is a powerful web tool designed for research data management, providing versatile features across multiple platforms. Whether you're working in the browser, VS Code, Electron, or Excel, Swate enhances your data management workflow with a seamless experience.

Available Platforms:

• Web Tool: swate-alpha.nfdi4plants.org
• VS Code Plugin: arc-vs-code
• Electron App: ARCitect
• Excel Add-In: ARC Excel Add-In

Features:

• Seamless integration across multiple platforms
• Rich set of tools for managing and annotating research data
• React Components released as npm package @nfdi4plants/swate-components
• Fable NuGet package Swate.Components for .NET developers
• Storybook available for component previews

🚀 Getting Started

To get started with Swate, choose your preferred platform:

1. Web Tool: Visit swate-alpha.nfdi4plants.org
2. Electron App: Download and install the app from the GitHub Releases Page
3. Excel Add-In: Find installation instructions in the knowledgebase

If you choose to use the ARCitect you can also follow along our Tutorial Violas Journey 🪻

📖 Documentation

You can find indepth documentation on how to use Swate on our knowledgebase.

Most information based on ARCitect can be transferred to other Swate platforms.

🔨⛏️ Installation for Developers

React Components

• JavaScript: Install via npm:

  npm install @nfdi4plants/swate-components
  

• Fable F#: Install via NuGet:

  dotnet add package Swate.Components
  

📖 Storybook Preview

See all available components in action by visiting our Storybook.

🌱 Contributing + Development Setup

Any help is welcome, from a typo fix to a new feature. If you are unsure about anything, just ask. We are here to help you help us.

If you want to contribute or just check out Swate on your local machine have a look at the CONTRIBUTING.md file.