https://github.com/4lessandrodev/boilerplate
Template to start a new configured next project
https://github.com/4lessandrodev/boilerplate
Last synced: about 1 year ago
JSON representation
Template to start a new configured next project
- Host: GitHub
- URL: https://github.com/4lessandrodev/boilerplate
- Owner: 4lessandrodev
- Created: 2021-08-24T05:17:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-15T11:51:24.000Z (over 3 years ago)
- Last Synced: 2025-01-07T14:25:06.129Z (about 1 year ago)
- Language: TypeScript
- Size: 765 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Template to start a new next.js configured project
> Use this repository to start a new next configured app
`$ yarn create next-app -e https://github.com/4lessandrodev/boilerplate `
## What is inside?
This project uses lot of stuff as:
- [TypeScript](https://www.typescriptlang.org/)
- [NextJS](https://nextjs.org/)
- [Styled Components](https://styled-components.com/)
- [Jest](https://jestjs.io/)
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
- [Storybook](https://storybook.js.org/)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [Husky](https://github.com/typicode/husky)
- [CommitLint](https://www.npmjs.com/package/git-commit-msg-linter)
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](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.
## 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 to test all components and pages
- `test:watch`: runs jest in watch mode
- `storybook`: runs storybook on `localhost:6006`
- `build-storybook`: create the build version of storybook
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.