@visiosto/web-utilities
v0.2.0
Published
Collection of JavaScript utilities used by Visiosto's web projects
Downloads
1
Readme
Visiosto Web Utilities
A collection of JavaScript utilities used by Visiosto’s web projects.
Install
You can install @visiosto/web-utilities
with your favourite package manager.
With yarn
yarn add @visiosto/web-utilities
With npm
npm install --save @visiosto/web-utilities
Local development
To run or build @visiosto/web-utilities
locally, please ensure that you have Node.js and Yarn installed. Please note that this project uses the Yarn Classic.
First, clone the GitHub repository of @visiosto/web-utilities
.
Via HTTPS: If you’re checking out sources as read-only, HTTPS works best.
git clone https://github.com/visiosto/components.git
Via SSH: If you’re planning on regularly making direct commits, cloning over SSH may provide a better experience (it requires uploading SSH keys to GitHub)
git clone [email protected]:visiosto/components.git
Via GitHub CLI: If you work chiefly with GitHub, using the official GitHub CLI may provide the best experience.
gh repo clone visiosto/components
After cloning the source, make sure to change to the cloned directory.
cd components
Then install the dependencies.
yarn
Finally, to build @visiosto/web-utilities
.
yarn dist
Contributing
Contributions to the website are welcome and encouraged! There are many ways to contribute to @visiosto/web-utilities
. You can find the guidelines for contributing in CONTRIBUTING.
This project adheres to the Contributor Covenant Code of Conduct. By participating, you’re expected to uphold this code. Please report unacceptable behaviour to [email protected].
Licence
@visiosto/web-utilities
is licensed under the MIT License.