Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamdevmarcos/Nextjs-Boilerplate
A simple project starter to work with TypeScript, React, Next.js, Chakra UI, React Hook Form and Zod ♻️
https://github.com/iamdevmarcos/Nextjs-Boilerplate
chakra-ui jest nextjs react reacthookform reactjs testing-library typescript zod
Last synced: about 2 months ago
JSON representation
A simple project starter to work with TypeScript, React, Next.js, Chakra UI, React Hook Form and Zod ♻️
- Host: GitHub
- URL: https://github.com/iamdevmarcos/Nextjs-Boilerplate
- Owner: iamdevmarcos
- License: mit
- Created: 2022-06-07T16:38:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-30T21:02:34.000Z (over 1 year ago)
- Last Synced: 2024-08-01T08:14:25.497Z (4 months ago)
- Topics: chakra-ui, jest, nextjs, react, reacthookform, reactjs, testing-library, typescript, zod
- Language: TypeScript
- Homepage: https://boilerplate-iamdevmarcos.vercel.app/
- Size: 4.64 MB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - iamdevmarcos/Nextjs-Boilerplate - A simple project starter to work with TypeScript, React, Next.js, Chakra UI, React Hook Form and Zod ♻️ (TypeScript)
README
[Next.js](https://nextjs.org/) boilerplate
## What is inside?
This project uses lot of stuff as:
- [TypeScript](https://www.typescriptlang.org/)
- [NextJS](https://nextjs.org/)
- [Chakra UI](https://chakra-ui.com/)
- [React Hook Form](https://react-hook-form.com/)
- [Zod](https://zod.dev/)
- [Jest](https://jestjs.io/)
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [Husky](https://github.com/typicode/husky)
## Getting Started
First, to create a project using this boilerplate, use this command:
```bash
npx create-next-app -e https://github.com/iamdevmarcos/my-boilerplate
```
Install all dependencies:
```bash
yarn install
```
Run the development server:
```bash
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
- `generate`: consistently create components using plopjs
- `test`: runs jest to test all components and pages
- `test:watch`: runs jest in watch mode
- `prepare`: starts husky install and configuration
## 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.