Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zaujulio/zbp

Boilerplate with tests, pwa, code styling and git hooks
https://github.com/zaujulio/zbp

boilerplate ci-cd nextjs styled-components testing

Last synced: 5 days ago
JSON representation

Boilerplate with tests, pwa, code styling and git hooks

Awesome Lists containing this project

README

        

# ZBP - πŸ”ŽπŸ§ͺβš›πŸŽ¨

Boilerplate Nextjs + Typescript with tests, PWA (Optional), code styling, templates and git hooks.

- [[Eslint πŸ”Ž]](https://github.com/eslint/eslint): Analyzes the code and generates error warnings.
- [[Prettier 🎨]](https://github.com/prettier/prettier): formats the code, giving that little hand to Eslint and reverse.
- [[lint-staged πŸš«πŸ’©]](https://github.com/okonet/lint-staged): Makes the LINTING all files that are changed.
- [[Husky 🐢]](https://github.com/typicode/Husky): Creates Commit Hooks to automate code verification (types, styles, etc.).
- [[Jest πŸ§ͺ]](https://jestjs.io/): Unit testing framework.
- [[React Testing Library πŸ§ͺβš›]](https://testing-library.com/docs/react-testing-library/intro): Testing library for React.
- [[PWA 🀹]](https://developers.google.com/web/progressive-web-apps/): Websites that took all the right vitamins.
- [[Nextjs πŸš€]](https://nextjs.org/): Nextjs is a framework for server-rendered React applications.
- [[Typescript 🧩]](https://www.typescriptlang.org/): TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
- [[Styled Components πŸͺ…]](https://styled-components.com/): Styled Components is a library for React that allows you to write styles in a modular, statically-typed, and highly reusable way.
- [[Plop 🧩]](https://plopjs.com/): Plop is a little tool that saves you time and helps your team build new files with consistency.

## Installation

```console
foo@bar:~$ npm create-next-app -e https://github.com/ZauJulio/ZBP

or

foo@bar:~$ yarn create next-app -e https://github.com/ZauJulio/ZBP
```

## Scripts

```json
{
"dev": "Runs the development server",
"build": "Builds the application for production",
"start": "Start the production server",
"lint": "Lint the code, with a maximum of 0 Warnings",
"test": "Runs the unit tests",
"testwatch": "Runs the unit tests in watch mode, to each change",
"test:coverage": "Generates a coverage report",
"storybook": "Runs the Storybook server of components, enjoy your playground",
"generate": "Generates a new component with tests, styles and stories",
"build-storybook": "Builds the Storybook static playground"
}
```

Inspired by: React Avançado course;


ZauJulio πŸ§ͺ