https://github.com/oraichain/datahub-starterkit
https://github.com/oraichain/datahub-starterkit
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/oraichain/datahub-starterkit
- Owner: oraichain
- License: apache-2.0
- Archived: true
- Created: 2021-08-31T05:02:28.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-20T05:24:17.000Z (about 2 years ago)
- Last Synced: 2025-02-28T12:18:55.296Z (4 months ago)
- Language: JavaScript
- Size: 7.73 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Label Studio Frontend ·    · :sunny:
[Website](https://labelstud.io/) • [Docs](https://labelstud.io/guide) • [Twitter](https://twitter.com/heartexlabs) • [Join Slack Community 
](https://docs.google.com/forms/d/e/1FAIpQLSdLHZx5EeT1J350JPwnY2xLanfmvplJi6VZk65C2R4XSsRBHg/viewform?usp=sf_link)
**Label Studio is an open-source, configurable data annotation tool. :v:**
Frontend, as its name suggests, is the frontend library developed using React and mobx-state-tree, distributed as an NPM package. You can include it in your applications and provide data annotation support to your users. It can be granularly customized and extended.
## Install
```bash
npm install label-studio
```
## Usage
**With Webpack**
```js
import LabelStudio from 'label-studio';
import 'label-studio/build/static/css/main.css';
```
**With UNPKG.com**
```xhtml
```
**Initialization**
```xhtml
var labelStudio = new LabelStudio('label-studio', {
config: `
<View>
<Image name="img" value="$image"></Image>
<RectangleLabels name="tag" toName="img">
<Label value="Hello"></Label>
<Label value="World"></Label>
</RectangleLabels>
</View>
`,
interfaces: [
"panel",
"update",
"submit",
"controls",
"side-column",
"annotations:menu",
"annotations:add-new",
"annotations:delete",
"predictions:menu",
],
user: {
pk: 1,
firstName: "James",
lastName: "Dean"
},
task: {
annotations: [],
predictions: [],
id: 1,
data: {
image: "https://htx-misc.s3.amazonaws.com/opensource/label-studio/examples/images/nick-owuor-astro-nic-visuals-wDifg5xc9Z4-unsplash.jpg"
}
},
onLabelStudioLoad: function(LS) {
var c = LS.annotationStore.addAnnotation({
userGenerate: true
});
LS.annotationStore.selectAnnotation(c.id);
}
});
```
## Development
1. Clone the repository
```bash
git clone [email protected]:heartexlabs/label-studio-frontend.git
# or: git clone https://github.com/heartexlabs/label-studio-frontend.git
cd label-studio-frontend
```
2. Install required dependencies
```bash
npm install
```
3. Start the development server
```bash
npm run start
```
4. Check different ways to initiate the development server config & task data in `src/env/development.js`, changing the `data` variable is a good place to start.
5. After you make changes and ready to use it in production, you need to create a production build
```bash
npm run build-bundle
```
Now you have one .js file and one .css file in the `build/static/` directory
## Label Studio for Teams, Startups, and Enterprises :office:
Label Studio for Teams is our enterprise edition (cloud & on-prem), that includes a data manager, high-quality baseline models, active learning, collaborators support, and more. Please visit the [website](https://www.heartex.ai/) to learn more.
## Ecosystem
| Project | Description |
|-|-|
| [label-studio](https://github.com/heartexlabs/label-studio) | Server part, distributed as a pip package |
| label-studio-frontend | Frontend part, written in JavaScript and React, can be embedded into your application |
| [label-studio-converter](https://github.com/heartexlabs/label-studio-converter) | Encode labels into the format of your favorite machine learning library |
| [label-studio-transformers](https://github.com/heartexlabs/label-studio-transformers) | Transformers library connected and configured for use with label studio |
## License
This software is licensed under the [Apache 2.0 LICENSE](/LICENSE) © [Heartex](https://www.heartex.ai/). 2020
