juliocarneiro / boilerplate-next-ts

NextJS, Typescript, Storybook, Jest, Styled-components, devops with snyk and github actions with pipeline.

This is a Next.js boilerplate with Typescript and Styled-Components.

What is inside?

This project uses lot of stuff as:

• TypeScript
• NextJS
• Styled Components
• Jest
• React Testing Library
• Eslint
• Prettier
• Husky
• Storybook
• GiHub Actions
• Docker
• Snyk

Getting Started

First, install snyk and project dependencies:

yarn global add snyk

yarn

Now, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Or start project with docker image

docker-compose up

Commands

• dev: runs your application on localhost:3000
• build: creates the production build version
• start: starts a simple server with the build production code
• lint: runs the linter in all components and pages
• test: runs jest in watch mode
• test:ci: runs jest to test all components and pages one time
• security: runs snyk for search vulnerabilities
• security-fix: fix vulnerabilities
• protect: update libs with vulnerabilities
• generate: generate component paste with index, test and styled (ex: yarn generate Home)
• storybook: Initialize and watch Storybook

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Prod

In production (Vercel) https://boilerplate-next-ts-seven.vercel.app

Check out our Next.js deployment documentation for more details.