🟣 @ricardojrmcom/supernova

React Module Boilerplate

---

Bootstrap

npx @ricardojrmcom/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

---

Install

npm install @ricardojrmcom/supernova

yarn add @ricardojrmcom/supernova

Usage

// component
import {
  ExampleComponent,
  ExampleComponentProps,
} from '@ricardojrmcom/supernova';

// hook
import { useExampleHook, ExampleHookType } from '@ricardojrmcom/supernova';

// context
import {
  ExampleContext,
  useExampleContext,
  ExampleContextType,
} from '@ricardojrmcom/supernova';

// provider
import {
  ExampleProvider,
  ExampleProviderProps,
} from '@ricardojrmcom/supernova';

Scripts

// install deps
yarn install

// run build
yarn build

// run lint
yarn lint

// run unit tests
yarn test

// run storybook
yarn sb

Project

• Project Page
• Source Code
• Releases Page

Project Dependencies

• TS Package Boilerplate: 🟪 @ricardojrmcom/nova
• React Module Boilerplate: 🟣 @ricardojrmcom/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 (@ricardojrmcom)

Bootstrapped with 🟣@ricardojrmcom/supernova