Skip to content

The goal of this module is to provide multiple javascript packages that can be reused in different javascript applications.

License

Notifications You must be signed in to change notification settings

Jahia/javascript-components

Repository files navigation

Welcome to Jahia JavaScript Monorepo 👋

Version Auto Release License: JAHIA'S DUAL LICENSING Twitter: Jahia

Monorepo of all front-end library of Jahia

Projects

This project is composed of (click on the link for there documentation):

Installation

Each package in the javascript-components repository is published to the public npm registry and scoped with @jahia. You can install any package with:

npm i @jahia/package-name

or with yarn : yarn add @jahia/package-name.

Development

Getting started

This monorepo uses Node and Yarn. The easiest way to install Node and Yarn is to use mise install.

Before starting developing, you have to install dependencies:

yarn

The you can start develop and test using.

yarn tdd

Make sure each file respect the eslint configuration.

Working with yalc

Sometime, when you are working on a JavaScript-Component package, you want to directly test your package on the other project you are working on. Yalc is here to help you do that.

Build

In order to build every package, in the root folder, run:

yarn build

The final build will reside in the dist subfolder of each package.

Modules can also be built independently by going to packages subfolder, and use yarn build.

Publish

Publication is done automatically when merging the release PR created by Chachalog.

Author

👤 Jahia Group

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Jahia Group.
This project use JAHIA'S DUAL LICENSING, see LICENSE.txt file.


This README was generated with ❤️ by readme-md-generator

About

The goal of this module is to provide multiple javascript packages that can be reused in different javascript applications.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 29