https://github.com/ricardojrmcom/supernova

React module boilerplate
https://github.com/ricardojrmcom/supernova

boilerplate cicd eslint husky jest npm prettier react react-testing-library storybook typescript

Last synced: 19 days ago
JSON representation

React module boilerplate

• Host: GitHub
• URL: https://github.com/ricardojrmcom/supernova
• Owner: ricardojrmcom
• License: mit
• Created: 2021-10-22T21:11:40.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-29T04:59:26.000Z (over 2 years ago)
• Last Synced: 2024-10-19T05:16:32.673Z (2 months ago)
• Topics: boilerplate, cicd, eslint, husky, jest, npm, prettier, react, react-testing-library, storybook, typescript
• Language: TypeScript
• Homepage:
• Size: 414 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 🟣 `@ricardojrmcom/supernova`

React Module Boilerplate

![build](https://img.shields.io/github/workflow/status/ricardojrmcom/supernova/Continuous%20Integration?style=for-the-badge)

![license](https://img.shields.io/github/license/ricardojrmcom/supernova?style=for-the-badge)

![author]()

![lang](https://img.shields.io/github/languages/top/ricardojrmcom/supernova?style=for-the-badge)

![version](https://img.shields.io/npm/v/@ricardojrmcom/supernova?style=for-the-badge)

![size](https://img.shields.io/bundlephobia/min/@ricardojrmcom/supernova?style=for-the-badge)






---




### Bootstrap

```tsx

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

```tsx

npm install @ricardojrmcom/supernova

yarn add @ricardojrmcom/supernova

```




### Usage

```tsx

// 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

```tsx

// install deps

yarn install

// run build

yarn build

// run lint

yarn lint

// run unit tests

yarn test

// run storybook

yarn sb

```




### Project

- [Project Page](https://l1b3r.notion.site/supernova-382adadc317c4ec189b6643bcdfffc09)

- [Source Code](https://github.com/ricardojrmcom/supernova)

- [Releases Page](https://github.com/ricardojrmcom/supernova/releases)




### Project Dependencies

- TS Package Boilerplate: [🟪 @ricardojrmcom/nova](https://github.com/ricardojrmcom/nova)

- React Module Boilerplate: [🟣 @ricardojrmcom/supernova](https://github.com/ricardojrmcom/supernova)




### Dev Dependencies

- `Yarn`

- `Typescript`

- `React`

- `Prettier`

- `ESLint`

- `Commit Lint`

- `Lint Staged`

- `Husky`

- `Jest`

- `React Testing Library`

- `Storybook`

- `Webpack`

- `Semantic Release`




---




### License

[MIT](https://github.com/ricardojrmcom/supernova/blob/main/LICENSE) © Ricardo  Mota ([@ricardojrmcom](https://github.com/ricardojrmcom))

Bootstrapped with 🟣[@ricardojrmcom/supernova](https://github.com/ricardojrmcom/supernova)