- This is a Next.Js boilerplate configured to support: Typescript, Tailwind CSS, Storybook, Cypress, Jest, React Testing Library, SWR
- It helps you start your Next.JS project faster and more easily containing some samples on each of the technologies used
- run 'npm install' command to install all the dependencies
- run 'npm run dev' or 'yarn dev' to start the development environment on 'localhost:3000'
- run 'npm test' to start unit tests run in watch mode as default
- run 'npm run test:coverage' to see the coverage report of your application
- run 'npm run cypress:run' to run end-to-end testing
- run 'npm run cypress:open' to open the cypress dashboard for observing your end-to-end test result
- run 'npm run storybook' to lunch storaybook dashboard of your stories
- run 'npm run serve-json' to host json server mock APIs on 'localhost:4000' in case you need some mock data
- Jest is configured in jest folder containiong jest.config.js and jest.setup.js
- Storybook is configured in .storybook folder containg preview.js and main.js
- Typescript is configured in tsconfig.json file
- Cypress is configured in cypress.config.js
- TailwindCSS is configured in tailwind.config.js
- you can define the mock data structure in db.json file placed in jsonServer folder in the root directory
- you can update your application metadata in src->core->siteConfig->headConfing
- you can place your documents in the folder with the same name preferably in .md format
- you can define a header and footer for the app in the related components or simply remove it from layout, nested layout woulbe be added in next updates