eResearch Team Charter

Overview

https://eresearchqut.github.io/team-charter/

Stack

• Next.js 13
• Chakra UI
• Jest - Test runner
• TypeScript - Type checking
• Storybook - Component library
• ESLint - Code linting
• Prettier - Code formatting

Commands

• yarn run dev - Starts the development server.
• yarn run test - Runs the unit tests.
• yarn run storybook - Starts the Storybook UI.
• yarn run lint - Runs ESLint on the project.
• yarn run format:fix - Formats code for the entire project

State management

For this starter kit we are not using a global state manager but instead storing state inside the routes for Next.js. For example, please look at the /src/pages/counter-example.tsx and src/pages/fetch-example.tsx files.

Testing

Unit testing

The unit tests for the components can be found in the __tests__ directory.

.
├── StickyNote.test.tsx
└── index.test.tsx

Storybook's Accessibility testing

This starter kit comes with the @storybook/addon-a11y which is used to check for common accessibility errors in your components. When you run yarn run storybook, each story will show detailed explanations with suggested fixes if errors are found.