Unly Utils
January 31, 2020 ยท View on GitHub
Unly Utils
This is a utility library which contains various helpers. This repository was created because those helpers are used amongst several projects and were copy/pasted, which is a bad practice.
- Getting started
- API
- Contributing
- License
- Vulnerability disclosure
- Contributors and maintainers
- [ABOUT UNLY]
Getting started
npm or yarn
yarn add @unly/utils
Usage example:
const { isBrowser, convertLineBreaks, browserRedirect } = require('unly-utils');
API
Contributing
We gladly accept PRs, but please open an issue first so we can discuss it beforehand.
Getting started
yarn start # Shortcut - Runs linter + build + tests in concurrent mode (watch mode)
OR run each process separately for finer control
yarn lint
yarn build
yarn test
Test
yarn test # Run all tests, interactive and watch mode
yarn test:once
yarn test:coverage
Releasing and publishing
yarn releaseAndPublish # Shortcut - Will prompt for bump version, commit, create git tag, push commit/tag and publish to NPM
yarn release # Will prompt for bump version, commit, create git tag, push commit/tag
npm publish # Will publish to NPM
License
MIT
Vulnerability disclosure
Contributors and maintainers
This project is being maintained by:
- [Unly] Ambroise Dhenain (Vadorequest) (active)
Thanks to our contributors:
- Anthony Troupenat (Fukoyamashisu)
[ABOUT UNLY]
Unly is a socially responsible company, fighting inequality and facilitating access to higher education. Unly is committed to making education more inclusive, through responsible funding for students. We provide technological solutions to help students find the necessary funding for their studies.
We proudly participate in many TechForGood initiatives. To support and learn more about our actions to make education accessible, visit :
- https://twitter.com/UnlyEd
- https://www.facebook.com/UnlyEd/
- https://www.linkedin.com/company/unly
- Interested to work with us?
Tech tips and tricks from our CTO on our Medium page!
#TECHFORGOOD #EDUCATIONFORALL