Northwestern Libraries Admin React Components
A collection of Northwestern University Libraries React components, used cross-projects for creating Admin UI interfaces. Style guide via Styleguidist.
Style guide and examples
View the style guide and usage examples:
https://nulib.github.io/admin-react-components/styleguide/
Using the component library and assets
Add the package to your React project:
npm install --save @nulib/admin-react-components
Developing
To develop in the component repository:
- Clone the project
- Enter the
admin-react-components
directory:cd admin-react-components
- Install dependencies
npm install
Use Styleguidis for a development environment. Run:
npm run styleguide
which will spin up a local Styleguidist webpack dev server that handles live-reloading as you write tests, build out components, and write documentation.
Running the tests
npm run test
// or
npm run test:watch
Building the package
To build the package, we use Rollup:
npm run build
To directly build the latest version of the style guide:
npm run styleguide:build
ADR
To document architecture decisions, we use the adr-tools package. To document a new architecture decision via adr-tools
markdown template generator, run:
adr new your-text-here
Built With
- React - JavaScript components
- Bulma - UI CSS only framework
- Styleguidist - Used as development environment and style guide
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Adam J. Arling - Developer - Northwestern Univeristy Libraries Github
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details