@emunhoz/gitlab-components v1.0.0

Template for NPM React Module + TypeScript

About

A simple boilerplate to start building your own react library

🚀 Quick Start

1. Install all dependencies

   npm i

2. Show and build your components at http://localhost:61622/

   npm run storybook

What's included?

• React
• Typescript
• Styled components with ThemeProvider 💅
• Storybook with MDX Syntax
• Testing library/react (Setup working with ThemeProvider)

🌎 Publishing

Remember to rename "name": "@your-name/components", with your package name in package.json

1. Make sure you're logged in your npm account

   npm login

2. Compile your package

   npm run build

3. Update the package version

   npm version [patch | minor | major]

4. Publish your package

   npm publish

🚨 Code standard

• JavaScript Standard Style - Javascript styleguide
• Prettier - Code formatter
• ESLint - Lint to quickly find problems
• Stylelint - A mighty, modern linter that helps you avoid errors and enforce conventions in your styles

🚥 Testing

• Jest - A delightful JavaScript Testing Framework with a focus on simplicity
• Testing Library - Simple and complete testing utilities that encourage good testing practices

Others commands

npm run generate:component to create a component folder structure

npm run test:ci to run test code coverage

npm run deploy-storybook publish your storybook github pages