🟪 @ricardo-jrm/nova

Typescript NPM Package Boilerplate

Bootstrap

npx @ricardo-jrm/nova

Boilerplate TypeScript 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 @ricardo-jrm/nova

yarn add @ricardo-jrm/nova

Scripts

// install deps
yarn install

// run dev
yarn dev

// run build
yarn build

// run lint
yarn lint

// run unit tests
yarn test

Project

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

Usage

import { example, exampleType } from '@ricardo-jrm/nova';

example();

Dev Dependencies

• Yarn
• Typescript
• Nodemon
• Prettier
• ESLint
• Commit Lint
• Lint Staged
• Husky
• Jest
• Semantic Release

License

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

Bootstrapped with 🟪@ricardo-jrm/nova