https://github.com/nfdi4plants/swate
Excel Add-In for annotation of experimental data and computational workflows.
https://github.com/nfdi4plants/swate
biology education isa minimal-information ontology rdm research-data-management
Last synced: about 1 month ago
JSON representation
Excel Add-In for annotation of experimental data and computational workflows.
- Host: GitHub
- URL: https://github.com/nfdi4plants/swate
- Owner: nfdi4plants
- License: mit
- Created: 2020-04-29T12:57:50.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T13:58:19.000Z (about 1 month ago)
- Last Synced: 2025-04-09T10:04:48.978Z (about 1 month ago)
- Topics: biology, education, isa, minimal-information, ontology, rdm, research-data-management
- Language: F#
- Homepage: https://swate-alpha.nfdi4plants.org
- Size: 8.72 MB
- Stars: 37
- Watchers: 5
- Forks: 7
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Swate
> **Swate** - something or someone that gets you absolutely joyed ([Urban dictionary](https://www.urbandictionary.com/define.php?term=swate))
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](https://swate-alpha.nfdi4plants.org)
- **VS Code Plugin**: [arc-vs-code](https://github.com/nfdi4plants/arc-vs-code)
- **Electron App**: [ARCitect](https://github.com/nfdi4plants/ARCitect)
- **Excel Add-In**: [ARC Excel Add-In](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/guides/annotate-in-excel/)
### 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](https://swate-alpha.nfdi4plants.org)
2. **VS Code Plugin**: Find installation instructions in the [knowledgebase](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/guides/vs-code-extension/)
3. **Electron App**: Download and install the app from the [GitHub Releases Page](https://github.com/nfdi4plants/ARCitect/releases)
4. **Excel Add-In**: Find installation instructions in the [knowledgebase](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/guides/annotate-in-excel/)
If you choose to use the ARCitect you can also follow along our Tutorial [Violas Journey](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/start-here/) đĒģ
### đ Documentation
You can find indepth documentation on how to use Swate on our [knowledgebase](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/).
Most information based on ARCitect can be transferred to other Swate platforms.
### đ¨âī¸ Installation for Developers
#### React Components
- **JavaScript**:
Install via npm:
```bash
npm install @nfdi4plants/swate-components
```
- **Fable F#**:
Install via NuGet:
```bash
dotnet add package Swate.Components
```
### đ Storybook Preview
See all available components in action by visiting our [Storybook](https://nfdi4plants.github.io/Swate/).
### đą 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](CONTRIBUTING.md) file.