https://github.com/jukbot/next-starter-kit
NextJS Template for starting website with cypress setup
https://github.com/jukbot/next-starter-kit
Last synced: 9 days ago
JSON representation
NextJS Template for starting website with cypress setup
- Host: GitHub
- URL: https://github.com/jukbot/next-starter-kit
- Owner: jukbot
- Created: 2021-08-14T16:37:17.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-17T10:35:57.000Z (over 4 years ago)
- Last Synced: 2025-01-08T16:03:13.701Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SaltyAom's Next Starter
Starter template for blazing fast Next.js app:
## Featuring
- EsBuild
- Configured with esbuild loader, with faster build time.
- Starting at 28KB
- With Preact configuration reduce initial size to just 28KB.
- TypeScript
- Type-safe code base for faster and easier maintainance.
- Tailwind
- Present with both Tailwind as CSS module with `@tailwind` or global className as your choice
- 1 ClassName
- Reduce className to 1 digit when using CSS Module
- Sass and CSS Module
- Configured Sass to use with CSS module
- Dynamic Path Alias
- Easier manage and maintaining between module, no more import path hell.
- ESLint
- Configured linter for most suitable React environment
- Testing
- Using Jest and React Testing Library for testing.
- Github Action
- Run linter and test for every Pull Request
## Dynamic Path alias
List of path aliased:
- `@pages` - src/pages
- `@layouts` - src/layouts
- `@components` - src/components
- `@styles` - src/styles
- `@services` - src/services
- `@models` - src/models
- `@stores` - src/stores
- `@tailwind` - src/services/tailwind/index.ts
- `@atoms` - src/components/atoms
- `@molecules` - src/components/molecules
- `@organisms` - src/components/organisms
## Test Environment
Test suite is set up with Jest and React Testing Library with configured for using `next/dynamic`
The structure for test is illustrated as the following:
* __tests__ - Contains test file.
* __mocks__ - Mockup file like | (css|styl|.scss|.less) is set. (Can be changed at `jest.config.js`)