This is a Next.js boilerplate with Typescript and Styled-Components.
This project uses lot of stuff as:
- TypeScript
- NextJS
- Styled Components
- Jest
- React Testing Library
- Eslint
- Prettier
- Husky
- Storybook
- GiHub Actions
- Docker
- Snyk
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.
docker-compose up
dev
: runs your application onlocalhost:3000
build
: creates the production build versionstart
: starts a simple server with the build production codelint
: runs the linter in all components and pagestest
: runs jest in watch modetest:ci
: runs jest to test all components and pages one timesecurity
: runs snyk for search vulnerabilitiessecurity-fix
: fix vulnerabilitiesprotect
: update libs with vulnerabilitiesgenerate
: generate component paste with index, test and styled (ex:yarn generate Home
)storybook
: Initialize and watch Storybook
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!
In production (Vercel) https://boilerplate-next-ts-seven.vercel.app
Check out our Next.js deployment documentation for more details.