Note: xpub is still _very_ new. This repository contains an initial set of components but is not yet ready for use.
Note: xpub is still _very_ new. This repository contains an initial set of components but is not yet ready for use.
## Installing
In the root directory, run `npm install` then `npm run bootstrap` to install all the dependencies.
Note: this monorepo uses Lerna, which works best with npm v4 when linking unpublished packages. Hoisting is not yet reliable, so each component has its own node_modules folder.
## Contents
## Contents
### PubSweet components
### PubSweet components
*`component-app`: a PubSweet component that provides an app container with nav bar.
*`component-app`: a PubSweet component that provides an app container with nav bar and journal provider.
*`component-authentication`: a PubSweet component that provides authentication-related client pages.
*`component-authentication`: a PubSweet component that provides authentication-related client pages.
*`component-dashboard`: a PubSweet component that provides a Dashboard page.
*`component-dashboard`: a PubSweet component that provides a Dashboard page.
*`component-manuscript`: a PubSweet component that provides a Manuscript page.
*`component-manuscript`: a PubSweet component that provides a Manuscript page.
...
@@ -22,8 +16,18 @@ Note: this monorepo uses Lerna, which works best with npm v4 when linking unpubl
...
@@ -22,8 +16,18 @@ Note: this monorepo uses Lerna, which works best with npm v4 when linking unpubl
## xpub packages
## xpub packages
*`xpub-edit`: WYSIWYG editors for use in xpub forms
*`xpub-fonts`: fonts for use in xpub applications
*`xpub-fonts`: fonts for use in xpub applications
*`xpub-selectors`: some useful redux selectors
*`xpub-selectors`: some useful redux selectors
*`xpub-styleguide`: components for use in react-styleguidist
*`xpub-styleguide`: components for use in react-styleguidist
*`xpub-ui`: a library of user interface elements for use in PubSweet components.
*`xpub-ui`: a library of user interface elements for use in PubSweet components.
## Installing
In the root directory, run `npm install` then `npm run bootstrap` to install all the dependencies.
Note: this monorepo uses Lerna, which works best with npm v4 when linking unpublished packages. Hoisting is not yet reliable, so each component has its own node_modules folder.