This project was generated using https://github.com/UnlyEd/boilerplate-generator/tree/master/templates/typescript-OSS
- TODO (after generating a project from this boilerplate)
- Getting started
- Contributing
- Changelog
- License
- Vulnerability disclosure
- Contributors and maintainers
- [ABOUT UNLY]
- Rename occurrences of
PROJECT-NAME - Delete this
yarn install
Use:
yarn start
We gladly accept PRs, but please open an issue first so we can discuss it beforehand.
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
yarn test # Run all tests, interactive and watch mode
yarn test:once
yarn test:coverage
We use Semantic Versioning for this project: https://semver.org/. (vMAJOR.MINOR.PATCH: v1.0.1)
- Major version: Must be changed when Breaking Changes are made (public API isn't backward compatible).
- A function has been renamed/removed from the public API
- Something has changed that will cause the app to behave differently with the same configuration
- Minor version: Must be changed when a new feature is added or updated (without breaking change nor behavioral change)
- Patch version: Must be changed when any change is made that isn't either Major nor Minor. (Misc, doc, etc.)
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
Don't forget we are using SemVer, please follow our SemVer rules.
Pro hint: use beta tag if you're in a work-in-progress (or unsure) to avoid releasing WIP versions that looks legit
Our API change (including breaking changes and "how to migrate") are documented in the Changelog.
See changelog
MIT
This project is being maintained by:
- [Unly] Ambroise Dhenain (Vadorequest) (active)
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