This is a boilerplate repository that can be used for future personal projects. Feel free to fork this repository and modify it to your own needs.
This setup specifically does not use a UI library, and is pretty much a vanilla NextJS project with developer tools setup, so that way any developer can pick this up and install additional dependencies according to their own needs.
To get started, run npm install
. After that, you can run npm run dev
and find the website hosted at https://localhost:3000
.
Unit Tests:
npm run test
E2E Tests:
npm run test:e2e
Linting:
npm run lint
Lint (with fix option):
npm run lint:fix
View Storybook:
npm run storybook
- Framework: NextJS
- Component Documentation: Storybook
- E2E Tests: Playright
- Unit Tests: React-Testing-Library and Jest
- TypeScript
- Code Formatting: ESLint and Prettier
- Pre-Commit Hooks: Husky
- CI/CD: Github Actions
- Hosting: Vercel
Components can be found in the components
directory. This repository follows the Atomic Design pattern. They follow the following structure:
ComponentName/
├── index.ts # Exports CompnoentFile.tsx
├── ComponentFile.tsx # The Component
├── ComponentFile.test.tsx # Unit tests
└── ComponentFile.stories.tsx # Storybook file
E2E tests can be found in the e2e
directory.