Skip to content

nfdi4plants/Swate

Repository files navigation

Swate

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

Swate Logo

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:

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. VS Code Plugin: Find installation instructions in the knowledgebase
  3. Electron App: Download and install the app from the GitHub Releases Page
  4. Excel Add-In: Find installation instructions in the knowledgebase

🛠 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

Important

A quote i found years ago by @Thorium.

Imposter syndrome disclaimer: I want your help. No really, I do.

There might be a little voice inside that tells you you're not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.

I assure you, that's not the case.

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.