0.0.15 • Published 7 years ago
@crodity/crodity-ui v0.0.15
Crodity-UI
A set of React Components for Crodity.
Note: these instructions assumes that crodity-ui is the base name of the package.
Scripts
Install
npm install
Start
npm start
Build
npm run build
Folders
├── node_modules # node modules dependencies
├── lib # build folder
├── design # design requirements
├── scripts # scripts for build
├── src # source (components, mocks, static files)
├── public # public folder for docs
Bundling with your aplication
Use the source folder to bundle within your app, importing source files instead bundled files:
// recommended if you are not using all components, reduces bundle size
import Avatar from 'crodity-ui/src/avatar/Avatar';
// simpler way, allows you to import more than one component per import
import { Avatar } from 'crodity-ui/src';
Using build files
// recommended if you are not using all components, reduces bundle size
import Avatar from 'crodity-ui/lib/avatar/Avatar';
// simpler way, allows you to import more than one component per import
import { Avatar } from 'crodity-ui/lib';
import { Avatar } from 'crodity-ui';
Dependencies
- Material-UI (base components)
- Material-UI Fullscreen Dialog (overlay dialogs)
- React Masonry Component (photo gallery)
0.0.15
7 years ago