BrowseEverything (in Parcel)

Community Support

Overview

BrowseEverything is a JavaScript file upload library intended for integration into Ruby on Rails applications implemented using the Samvera digital repository framework.

Product Owner & Maintenance

Product Owner

jrgriffiniii

Help

The Samvera Community is here to help. Please see our support guide.

See the Samvera Confluence for information at the architectural level.

Additionally, new adopters and potential adopters may find the pages here useful: https://samvera.org/

Further questions? Get in touch

Development

Building the Package

$ yarn build

Viewing and Debugging the Package in the Browser

$ yarn parcel

Linting the Code Base (using ESLint)

$ yarn lint

Formatting the Code Base (using Prettier)

$ yarn format

Executing the Test Suites (using Jest)

$ yarn test

The JavaScript package should now be built within the directory dist/main.js.

License

BrowseEverything is available under the Apache 2.0 license.

Publishing

Testing Locally Using verdaccio

Using npm:

$ npx verdaccio
$ npm login --scope my-company --registry http://localhost:4873/
# Then, within another terminal
$ npm set registry http://localhost:4873/ --location project
# Please ensure that the "version" property in package.json has been incremented to the next release version
$ npm publish

Using yarn:

$ yarn verdaccio
$ npm login --scope my-company --registry http://localhost:4873/
# Then, within another terminal
$ yarn publish --registry http://localhost:4873/ --patch

Publishing Releases to npm

Using npm:

$ npm login
# Please ensure that the "version" property in package.json has been incremented to the next release version
$ npm publish

Using yarn:

$ yarn login
$ yarn publish --patch

Contributing

If you're working on a PR for this project, create a feature branch off of main.

This repository follows the Samvera Community Code of Conduct and language recommendations. Please do not create a branch called master for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.

Acknowledgments

This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera Community website.