Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@gliff-ai/upload
Advanced tools
@gliff-ai/upload - npm Package Compare versions
Comparing version 1.0.15 to 1.0.16
| { | ||
| "name": "@gliff-ai/upload", | ||
| "version": "1.0.15", | ||
| "version": "1.0.16", | ||
| "description": "gliff.ai UPLOAD - a React component for uploading multidimensional images", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.es.js", |
116
README.md
@@ -1,13 +0,72 @@ | ||
| # [gliff.ai](https://gliff.ai) UPLOAD | ||
| # gliff.ai UPLOAD | ||
| This repository contains the Open Source source code for [gliff.ai](https://gliff.ai)'s UPLOAD component for uploading multidimensional images. | ||
|       | ||
| Technical documentation will be available soon. | ||
| 👋 **Welcome in!** 👋 | ||
| This repository contains the Open Source code for [gliff.ai](https://gliff.ai)’s UPLOAD support library (gliff.ai’s component for uploading multidimensional images). | ||
| UPLOAD aims to allow users to easily upload a variety of image files, including multidimensional TIFFs, for the purposes of developing imaging AI products. When the full [gliff.ai platform](https://gliff.ai/software/) is used, UPLOAD provides just one step in developing high-quality and auditable datasets that satisfy any relevant regulatory frameworks which enables our users to build world-changing and trustworthy AI models and products. | ||
| ✅ **We welcome contributions on this repository!** ✅ | ||
| ## Table of Contents | ||
| Looking for something specific? 🔍 | ||
| - [Repository Introduction](#gliffai-upload) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Installation](#installation) | ||
| - [Development](#development) | ||
| - [Linting and Formatting](#linting-and-formatting) | ||
| - [Testing](#testing) | ||
| - [Examples of Use](#examples-of-use) | ||
| - [Contribute](#contribute) | ||
| - [Contact](#contact) | ||
| - [License](#license) | ||
| ## Installation | ||
| `npm install @gliff-ai/upload` will install the package from npm registry. | ||
| [{{back to navigation}}](#table-of-contents) | ||
| ## Examples of use | ||
| Run `npm install @gliff-ai/upload` in your command line to install the package from the npm registry. | ||
| ## Development | ||
| [{{back to navigation}}](#table-of-contents) | ||
| Frontend code should always be written in [Typescript](https://www.typescriptlang.org/) and transpiled using the options in `tsconfig.json` in this repository. npm should always be used for package management. | ||
| `npm run serve` will run a local webpack developer server for quick access. | ||
| To get started, run `npm i` and `npm run build` from the root directory. | ||
| ## Linting and Formatting | ||
| [{{back to navigation}}](#table-of-contents) | ||
| As a standard, all code contributions should be linted with [ESLint](https://eslint.org/) using `.eslintrc.js` and formatted with [Prettier](https://prettier.io/). **Note:** HTML + CSS, mark-up and mark-down code are exemptions and should be formatted using [Prettier](https://prettier.io/) but do not need to be linted. | ||
| `npm run lint` will lint the codebase. | ||
| Our GitHub Actions will also lint any pull requests before they're merged. | ||
| ## Testing | ||
| [{{back to navigation}}](#table-of-contents) | ||
| All code contributions should be tested using both the [Jest](https://jestjs.io/) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/). | ||
| `npm run test` will run any existing tests in our codebase. | ||
| Our GitHub Actions will also test any pull requests before they're merged! These all must pass and have 2 reviewers approval before a pull request can merge. If one or a few fail and your troubleshooting is not giving an answer, please check out the [gliff.ai Contribution Guide](https://github.com/gliff-ai/.github/blob/main/CONTRIBUTING.md) 👋 for further guidance. | ||
| ## Continuous Integration | ||
| [{{back to navigation}}](#table-of-contents) | ||
| GitHub Actions should only be included under the `.github/workflows` path. | ||
| ## Examples of Use | ||
| Import the `UploadImage` module and the `ImageFileInfo` type: | ||
@@ -46,43 +105,26 @@ | ||
| ## Development | ||
| ## Contribute | ||
| Frontend code should be written in [Typescript](https://www.typescriptlang.org/) and transpiled using the options in `tsconfig.json`. | ||
| Frontend code is distributed using the npm registry. | ||
| NPM should be used for package management. | ||
| [{{back to navigation}}](#table-of-contents) | ||
| Please follow [gliff.ai](https://gliff.ai)'s Community Guidelines when contributing to this codebase. | ||
| We welcome all contributors and any contributions on this project through the likes of feedback on or suggesting features and enhancements, raising bug problems, reporting on security vulnerabilities, reviewing code, requesting or creating tests, user testing etc. to ensure gliff.ai can help enable the best and biggest positive impact possible. | ||
| Run `npm i` and `npm run build` from the root directory to get started. | ||
| Sounds good and want to contribute to the project? 🧑💻 \ | ||
| Please check the [gliff.ai Contribution Guide]((https://github.com/gliff-ai/.github/blob/main/CONTRIBUTING.md)) 👋 before you get started. Don’t forget the [gliff.ai Code of Conduct]((https://github.com/gliff-ai/.github/blob/main/CODE_OF_CONDUCT.md)) ⚠️ and [gliff.ai Security Policy]((https://github.com/gliff-ai/.github/blob/main/SECURITY.md)) 🔒 too! | ||
| You can import this package by running `npm link` in the package directory, then `npm link @gliff-ai/upload` in the directory where you want to use the package (this will create a symbolic link). | ||
| A big thank you from the entire gliff.ai team to these fellow contributors ([emoji key](https://allcontributors.org/docs/en/emoji-key)): \ | ||
| [{{Contributor List - _coming soon_}}](https://github.com/all-contributors/all-contributors) | ||
| ## Linting and formatting | ||
| ## Contact | ||
| Code should be linted with [ESLint](https://eslint.org/) using `.eslintrc.js` and formatted with [Prettier](https://prettier.io/). | ||
| HTML + CSS, mark-up and mark-down should all be formatted using prettier. | ||
| [{{back to navigation}}](#table-of-contents) | ||
| `npm run lint` will lint the codebase. | ||
| Need some help? 🤔 Have a question? 🧠 \ | ||
| Reach out to the gliff.ai team at [community@gliff.ai](mailto:community@gliff.ai?subject=[GitHub]) or on GitHub. | ||
| We also provide a [pre-commit](https://pre-commit.com/) config for running a variety of linters locally on commit. | ||
| ## License | ||
| Our GitHub Actions will also lint any pull requests before they're merged. | ||
| [{{back to navigation}}](#table-of-contents) | ||
| ## Testing | ||
| Code should be tested using [Jest](https://jestjs.io/) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/). | ||
| `npm run test` will run any existing tests in our codebase. | ||
| We also provide a [pre-commit](https://pre-commit.com/) config for running a tests locally before a push. | ||
| Our GitHub Actions will also test any pull requests before they're merged. | ||
| ## Continuous integration | ||
| Pre-commit actions should be configured in `.pre-commit-config.yaml`. | ||
| GitHub Actions should be included under `.github/workflows`. | ||
| ## License | ||
| This code is licensed under a GNU AGPLv3 license. Our reasons for this will be published on our website soon. | ||
| This code is licensed under a [GNU AGPLv3 license](https://github.com/gliff-ai/upload/blob/main/LICENSE) 📝 \ | ||
| Curious about our reasoning for this? Read about them [here](https://gliff.ai/articles/open-source-license-gnu-agplv3/)! |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.23%
261107
- Number of lines in readme file
- increased by47.73%
130
No dependency changes