0.0.3 • Published 3 years ago
libscieverse v0.0.3
libscieverse
React component library, by liberate science.
Install Peer Dependencies
npm install --save react styled-components
Install
npm install --save libscieverse
Usage
import React from 'react'
import { ThemeProvider, Button } from 'libscieverse'
const App = () => {
return (
<ThemeProvider>
<Button backgroundColor='primary' color='white'>
Hello, I am a styled button
</Button>
</ThemeProvider>
)
}
Live Demo
For examples of the libscieverse in action, checkout the storybook here.
Develop
This will open a storybook dev server on http://localhost:8080
$ npm start # this will open storybook
Build
This will output the cjs and es modules to the dist
folder
$ npm run build
Deploy github page
This will publish storybook as a Github page
$ npm run deploy-github-page
Publish to npm
(you need to be logged in via npm for publishing)
$ npm publish
Publish locally
To create a local TAR file to test before publishing, run
$ npm pack
This will create a file called libscieverse-1.0.0.tgz
You can use this file as a normal package dependency
by linking in your npm install
$ npm i path/to/libscieverse-1.0.0.tgz
License
MIT © libscie
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!