🟣 @ricardo-jrm/supernova

React Module Boilerplate

Bootstrap

npx @ricardo-jrm/supernova

Boilerplate React project bootstrapped with all necessary configs and workflows

Workflows

Quality Assurance

• Will lint code and run tests
• Runs on pull_request sync and push to main

Release

• Will create a GitHub release with auto generated versioning and changelog
• Will publish the package to the public NPM registry
• Runs on push to main and after the QA job

Publish to GitHub (Public)

• Will publish the package to the public GitHub registry
• Runs on workflow_dispatch

Project

• Project Page
• M0: MVP
• Source Code
• Releases Page

Install

npm install @ricardo-jrm/supernova

yarn add @ricardo-jrm/supernova

Usage

// component
import {
  ExampleComponent,
  ExampleComponentProps,
} from '@ricardo-jrm/supernova';

// hook
import { useExampleHook, ExampleHookType } from '@ricardo-jrm/supernova';

// context
import {
  ExampleContext,
  useExampleContext,
  ExampleContextType,
} from '@ricardo-jrm/supernova';

// provider
import { ExampleProvider, ExampleProviderProps } from '@ricardo-jrm/supernova';

Project Dependencies

• TS Package Boilerplate: 🟪 @ricardo-jrm/nova
• React Module Boilerplate: 🟣 @ricardo-jrm/supernova

Dev Dependencies

• Yarn
• Typescript
• React
• Prettier
• ESLint
• Commit Lint
• Lint Staged
• Husky
• Jest
• React Testing Library
• Storybook
• Webpack
• Semantic Release

License

MIT © Ricardo <l1b3r_-> Mota (@ricardo-jrm)

Bootstrapped with 🟣@ricardo-jrm/supernova