Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 3.07 KB

README.md

File metadata and controls

44 lines (28 loc) · 3.07 KB

foreman-js

theforeman javascript packages

Build Status: Linux PRs Welcome dependencies Status devDependencies Status code style: prettier

What is foreman-js?

This project is a monorepo using lerna to host more than one package. Projects maintained by https://theforeman.org.

Background

The work on this repository started based on a discussion on community.theforeman.org about refactoring the JavaScript stack of Foreman.

Vendor packages

Foreman and its plugins use many of the same JavaScript dependencies (npm packages). The main purpose of vendor is to gather these common dependencies into a single package.

Note: In Foreman & plugins JavaScript code, you do not need to import anything explicitly from vendor (import react from '@theforeman/vendor'); you can continue to import all modules like normal (import react from 'react';).

In your CSS code, the @import statements do need to be explicit; see this part of @theforeman/vendor readme.

Other packages

Contributing

Please check out the CONTRIBUTING.md, the roadmap.md and the open issues.