This is a Next.js project starter template.
- TypeScript
- Tailwind CSS
- Storybook
- ESLint
- Prettier
- husky
- lint-staged
First, run the development server:
npm run dev
# or
yarn devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
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!
This project is built with Tailwind CSS.
You can view documentation, visit tailwindcss.com.
Starting Storybook:
npm run storybook
# or
yarn storybookOpen http://localhost:6006 with your browser to explore components.
Visit Storybook's website to learn more about Storybook.
Documentation can be found Storybook's docs site.
Runing test:
npm run test
# or
yarn testFor the details of the testing libraries this project is using, refer to the below.
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.