0.0.2 • Published 2 years ago
herdpay-seedlings v0.0.2
Installation:
Usage:
yarn start
: start running dev-server for local developmentyarn storybook
: start running storybook server for previewing demo pageyarn build
: build index.js and index.d.ts file from src folderyarn build-storybook
: build index.html in demo folder for static hostingchagne setting in
package.json
use
npm login
andnpm publish
for publishing to https://www.npmjs.com/
yarn watch
: start typescript watch modeyarn lint
: use ESLint for manually checking files inside src folder
Usage for third-party import:
npm i @herdpay/seedlings
import library
// TypsScript
import React, { FC } from 'react';
import { MyButton, HerdPayColors } from '@herdpay/seedlings';
import { createTheme, ThemeProvider } from '@mui/material/styles';
const theme = createTheme({
palette: {
primary: {
main: HerdPayColors.primary.main,
},
},
typography: { fontFamily: 'Roboto' },
});
const MyApp: FC = () => (
<ThemeProvider theme={theme}>
<MyButton>My Button</MyButton>
</ThemeProvider>
);
export default MyApp;
Folder Structure
┌── .github/workflows # Settings for GitHub Actions
├── .storybook # Storybook settings
├── .vscode # VSCode settings for ESLint auto-fix function
├── demo # Storybook static file
├── dist # Bundled JS and TS declaration file for deployed npm package
├── src # All source code
│ ├── components # React components
│ │ └── button # Component folder
│ │ ├── MyButton.tsx # Component for npm package
│ │ └── MyButton.stories.tsx # Component displayed in storybook
│ ├── index.dev.tsx # Development entry that uses ReactDOM.redner for local development
│ └── index.tsx # Production entry that exports all components
├── .gitignore # Excluded files for ignoring Git version control
├── .eslintrc.js # ESLint settings
├── index.html # HTML for local development
├── README.md # README
├── package-lock.json # Package settings that locked the version of dependencies packages
├── package.json # Package settings that listed dependencies packages, npm scripts, project name etc.
├── webpack.config.common.js # Webpack settings in both development and production mode
├── webpack.config.dev.js # Webpack settings in development mode
├── webpack.config.prod.js # Webpack settings in production mode
└── tsconfig.json # TypeScript settings