upload

gliff.ai загрузку

Добро пожаловать!

Этот репозиторий содержит открытый исходный код для библиотеки поддержки загрузки Gliff.ai (компонент Gliff.ai для загрузки многомерных изображений).

Загрузка направлена ​​на то, чтобы позволить пользователям легко загружать различные файлы изображений, включая многомерные TIFFS, для целей разработки продуктов ИИ визуализации. Когда используется платформа Full Gliff.ai, upload обеспечивает только один шаг в разработке высококачественных и проверенных наборов данных, которые удовлетворяют любым соответствующим нормативным рамкам, которые позволяют нашим пользователям создавать изменяющие мировые и надежные модели и продукты ИИ.

✅ Мы приветствуем вклад в этот репозиторий! ✅

Оглавление

Ищете что -нибудь конкретное? ?

• Репозиторий введение
• Оглавление
• Установка
• Разработка
• Линовая и форматирование
• Тестирование
• Примеры использования
• Способствовать
• Контакт
• Лицензия

Установка

{{назад к навигации}}

Запустите npm install @gliff-ai/upload в свою командную строку, чтобы установить пакет из реестра NPM.

Разработка

{{назад к навигации}}

Код Frontend всегда должен быть записан в TypeScript и транспильтирован с использованием параметров в tsconfig.json в этом репозитории. NPM всегда следует использовать для управления пакетами.

npm run serve будет запускать локальный сервер разработчиков WebPack для быстрого доступа.

Чтобы начать, запустите npm i и npm run build из корневого каталога.

Линовая и форматирование

{{назад к навигации}}

В качестве стандарта все вклады кода должны быть сняты с помощью Eslint с использованием .eslintrc.js и отформатированы с красивым. ПРИМЕЧАНИЕ. HTML + CSS, разметка и поставка кода являются исключениями и должны быть отформатированы с использованием более красивого, но не нужно быть снятым.

npm run lint будет провести кодовую базу.

Наши действия GitHub также пройдут любые запросы на притяжение, прежде чем они объединятся.

Тестирование

{{назад к навигации}}

Все взносы кода должны быть проверены с использованием библиотеки Jest и React Testing.

npm run test будет выполнять любые существующие тесты в нашей кодовой базе.

Наши действия GitHub также будут проверять любые запросы на привлечение, прежде чем они объединятся! Все они должны пройти и иметь 2 рецензента, прежде чем запрос на притяжение сможет объединиться. Если один или несколько провалится, и ваш устранение неполадок не дает ответа, пожалуйста, ознакомьтесь с руководством по вкладу Gliff.ai для дальнейшего руководства.

Непрерывная интеграция

{{назад к навигации}}

Действия Github должны быть включены только в путь .github/workflows .

Примеры использования

Импортируйте модуль UploadImage и тип ImageFileInfo :

 import { UploadImage } from @ gliff - ai / upload ;
import type { ImageFileInfo } from @ gliff - ai / upload ;

Используйте модуль UploadImage :

 setUploadedImage = (
  imageFileInfo : ImageFileInfo ,
  slicesData : Array < Array < ImageBitmap >>
) : void => {
  this . imageFileInfo = imageFileInfo ;
  this . slicesData = slicesData ;
} ;

render = ( ) : ReactNode => (
  < UploadImage
    setUploadedImage = { this . setUploadedImage }
    spanElement = {
      < Button aria-label = "upload-picture" component = "span" >
        < Backup />
      </ Button >
    } // A <span> element that marks the clickable area.
    multiple // allow uploading multiple files at once; use multiple={false} to disallow
  />
) ;

В примере выше используется материал-UI.

Способствовать

{{назад к навигации}}

Мы приветствуем всех участников и любые вклады в этот проект, такие как отзывы или предлагая функции и усовершенствования, повышение проблем с ошибками, отчетность по уязвимости безопасности, просмотр кода, запрос или создания тестов, пользовательского тестирования и т. Д., Чтобы обеспечить Gliff.ai, чтобы помочь обеспечить наилучшее и наибольшее положительное влияние.

Звучит хорошо и хотите внести свой вклад в проект? ? ‍
Пожалуйста, проверьте руководство Gliff.ai, прежде чем начать. Не забудьте кодекс поведения Gliff.ai ️ И политика безопасности Gliff.ai тоже!

Большое спасибо всей команде Gliff.ai этим коллегам -участникам (Emoji Key):

Джош

Час Нельсон ? ? ? ? ️

Филипджексон ? ?

Крейг Купер ? ?

Этот проект следует за спецификацией всех контрибьюторов и использует всеконтрибьюторный смайлик, чтобы заслужить типы взносов нашего сообщества!

Контакт

{{назад к навигации}}

Нужна помощь? ? Есть вопрос? ?
Обратитесь к команде Gliff.ai по адресу [email protected] или на наших дискуссиях на Github.

Лицензия

{{назад к навигации}}

Этот код лицензирован по лицензии GNU AGPLV3
Любопытно о наших рассуждениях для этого? Читайте о них здесь!