gabrielguedess / nextjs-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

4.0 2.0 0.0 6.44 MB

⭐🚀 Boilerplate para projetos NextJs.

Home Page: https://nextjs-boilerplate-gabrielguedess.vercel.app

License: MIT License

Shell 0.68% TypeScript 72.03% JavaScript 5.40% Handlebars 2.67% HTML 0.34% MDX 18.87%

nextjs styled-components storybook testing-library husky commitizen react commitlint eslint jest

nextjs-boilerplate's Introduction

NextJs Boilerplate

A Better template with NextJs with technologies to improve development.

View Demo · Report Bug · Request Feature

Table of Contents

About The Project
Getting Started
- Prerequisites
- Installation
Configuration
Contributing
License
Deploying
Contact

About The Project

🛠 Built With

The following tools were used in building the project:

(back to top)

🌈 Storybook

Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation.

⬇️ Start Storybook

# With npm
npm run storybook

# With yarn
yarn storybook

# With pnpm
pnpm storybook

⬇️ Build Storybook

# With npm
npm run build-storybook

# With yarn
yarn build-storybook

# With pnpm
pnpm build-storybook

Storybook Deploy ▶️

(back to top)

🏅 Lighthouse

Lighthouse Details ▶️

(back to top)

🔍 Codecov

Codecov provides metrics and insights into the results of tests through code coverage reports. Coverage reports are used to determine which lines of code were tested and which lines were not tested, which may contain bugs and syntax errors.

(back to top)

🚀 Getting Started

Prerequisites

To clone and run this application, you'll need Git and NodeJs (which comes with npm) installed on your computer.

Installation

Clone the repository.

git clone https://github.com/GabrielGuedess/NextJs-Boilerplate

Go into the repository

cd NextJs-Boilerplate

Install dependencies.

# With npm
npm i

# With yarn
yarn

# With pnpm
pnpm i

Start project.

# With npm
npm run dev

# With yarn
yarn dev

# With pnpm
pnpm dev

Note If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

(back to top)

🚨 Configuration

See the open issues for a full list of proposed features (and known issues).

(back to top)

👏 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Fork the Project
Create your Feature Branch (git checkout -b feature/NewFeature)
Commit your Changes (git commit -m 'Add some NewFeature')
Push to the Branch (git push origin feature/NewFeature)
Open a Pull Request

(back to top)

📄 License

Distributed under the MIT License. See MIT license for more information.

(back to top)

🌐 Deploying

(back to top)

⭐ Contact

Gabriel Guedes - @GabrielRGuedess - [email protected]

Project Link: https://nextjs-boilerplate-gabrielguedess.vercel.app

Made with ♥ by 👨‍🚀 Gabriel Guedes 👋 Get in touch!

(back to top)

nextjs-boilerplate's People

Contributors

Stargazers

Watchers

nextjs-boilerplate's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

asdf

.tool-versions

node 20.6.0

pnpm 8.6.8

circleci

.circleci/config.yml

codecov 3.2.5

cimg/python 3.11.4

github-actions

.github/workflows/analysis.yml

actions/checkout v3

actions/setup-node v3

pnpm/action-setup v2.2.4

actions/cache v3

actions/upload-artifact v3

dawidd6/action-download-artifact v2

peter-evans/find-comment v2

peter-evans/create-or-update-comment v3.0.2

peter-evans/create-or-update-comment v3.0.2

.github/workflows/chromatic.yml

actions/checkout v3.5.3

actions/setup-node v3

pnpm/action-setup v2.2.4

chromaui/action v1

.github/workflows/ci.yml

actions/checkout v3.5.3

actions/setup-node v3

pnpm/action-setup v2.2.4

.github/workflows/coverage.yml

actions/checkout v3.5.3

actions/setup-node v3

pnpm/action-setup v2.2.4

codecov/codecov-action v3

.github/workflows/cypress.yml

actions/checkout v3.5.3

actions/setup-node v3

pnpm/action-setup v2.2.4

cypress-io/github-action v5.8.3

.github/workflows/lighthouse.yml

actions/checkout v3

actions/checkout v3

myactionway/lighthouse-badger-action v2.2

ubuntu 22.04

.github/workflows/release.yml

actions/checkout v3.5.3

actions/setup-node v3

pnpm/action-setup v2.2.4

npm

package.json

@emotion/is-prop-valid ^1.2.1

@next/bundle-analyzer ^14.0.0

next 14.0.0

next-pwa ^5.6.0

next-seo ^6.4.0

polished ^4.2.2

react 18.2.0

react-dom 18.2.0

sharp ^0.32.6

styled-components 6.1.0

@commitlint/cli ^18.2.0

@commitlint/config-conventional ^18.1.0

@commitlint/types ^18.1.0

@isnotdefined/stylelint-plugin ^3.1.0

@netlify/plugin-a11y 1.0.0-beta.1

@netlify/plugin-lighthouse ^5.0.0

@next/eslint-plugin-next ^14.0.0

@semantic-release/changelog ^6.0.3

@semantic-release/git ^10.0.1

@storybook/addon-a11y ^7.5.1

@storybook/addon-essentials 7.5.1

@storybook/addon-interactions ^7.5.1

@storybook/addon-links ^7.5.1

@storybook/addon-toolbars ^7.5.1

@storybook/addon-viewport ^7.5.1

@storybook/blocks ^7.5.1

@storybook/manager-api ^7.5.1

@storybook/nextjs 7.5.1

@storybook/react 7.5.1

@storybook/theming ^7.5.1

@testing-library/cypress ^10.0.1

@testing-library/jest-dom ^6.1.4

@testing-library/react ^14.0.0

@types/jest ^29.5.6

@types/next-pwa ^5.6.8

@types/node ^20.8.9

@types/react ^18.2.33

@typescript-eslint/eslint-plugin ^6.9.0

@typescript-eslint/parser ^6.9.0

chromatic ^7.5.4

commitizen ^4.3.0

cypress ^13.3.3

cz-conventional-changelog 3.3.0

eslint ^8.52.0

eslint-config-airbnb ^19.0.4

eslint-config-next ^14.0.0

eslint-config-prettier ^9.0.0

eslint-config-stylelint ^20.0.0

eslint-import-resolver-typescript ^3.6.1

eslint-mdx ^2.2.0

eslint-plugin-chai-friendly ^0.7.2

eslint-plugin-cypress ^2.15.1

eslint-plugin-import ^2.29.0

eslint-plugin-import-helpers ^1.3.1

eslint-plugin-jest ^27.6.0

eslint-plugin-jest-formatting ^3.1.0

eslint-plugin-jsx-a11y ^6.7.1

eslint-plugin-mdx ^2.2.0

eslint-plugin-prettier ^5.0.1

eslint-plugin-react ^7.33.2

eslint-plugin-react-hooks ^4.6.0

eslint-plugin-storybook ^0.6.15

eslint-plugin-styled-components-a11y ^2.1.31

eslint-plugin-unicorn ^48.0.1

husky ^8.0.3

jest ^29.7.0

jest-environment-jsdom ^29.7.0

jest-styled-components ^7.2.0

lint-staged ^15.0.2

next-sitemap ^4.2.3

plop ^4.0.0

postcss-styled-syntax ^0.5.0

prettier ^3.0.3

prettier-plugin-packagejson ^2.4.6

pretty-format ^29.7.0

semantic-release ^22.0.5

sort-package-json ^2.6.0

start-server-and-test ^2.0.1

storybook 7.5.1

storybook-addon-designs ^6.3.1

storybook-addon-performance ^0.17.1

storybook-addon-pseudo-states ^2.1.2

storybook-dark-mode ^3.0.1

stylelint ^15.11.0

stylelint-config-clean-order ^5.2.0

stylelint-config-prettier ^9.0.5

stylelint-config-recommended ^13.0.0

stylelint-config-styled-components ^0.1.1

stylelint-group-selectors ^1.0.10

stylelint-order ^6.0.3

stylelint-use-nesting ^4.1.0

stylelint-z-index-value-constraint ^1.3.0

ts-node ^10.9.1

ts-prune ^0.10.3

typescript ^5.2.2

node >=18.0.0

nvm

.nvmrc

node 19.9.0

Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.