Skip to content

Basic boilerplate for Next.js projects using Typescript, Tailwind; with testing features from Jest & React Testing Library & Commit Linting with Lint-Staged & Huksy

License

Notifications You must be signed in to change notification settings

Digitl-Alchemyst/next-13.5-alchemy-base

Repository files navigation

    Next.js 13.5 BoilerPlate Base

Basic boilerplate for Next.js projects using Typescript, Tailwind; with testing features from Jest & React Testing Library & Commit Linting with Lint-Staged & Huksy


    Features

Testing
=> Jest
=> React Testing Library
Commits
=> Husky
=> Lint-Staged
Imports
=> @ = ./src
=> @/c = ./src/components
=> @/h = ./src/hooks
=> @/l = ./src/lib
=> @/s = ./src/styles
=> @/u = ./src/util
=> # = ./
=> ! = ./public
=> $ = ./schemas

    Project State

Project version updated for Next.js 13.5.3 [This project will be maintained to remain current with Next.js @latest until otherwise noted.] This is ready to use in its current state This project is set up with Jest and React Testing Library for code testing, it has been configured to work with Typescript. Custom imports have been set up. Eslint settings are preconfigured using a moderately strict ruleset. Uses ESLint to parse to Typescript. Sets specific rules for for testing envrioment (files within the tests directory or files with names ending in .spec.js, .test.js, .ts, .jsx, or .tsx). Configured Import Resolver to handle custom import settings. Uses Lint-Staged & Husky to Lint & format with prettier all files before commiting updates.

🚀 Tailwind CSS Extensions


🌈 Neon Shadows
🌀 Slower Spin Animation
🙈 Scrollbar Hide

    How to use

Project Dependencies

Next.js 13.5.3
React 18.2.0
npm/npx 9.5.1
Typescript 5.2.2
Tailwind CSS 3.3.3

Packages

Prettier 3.0.3
Tailwind Scrollbar 3.0.5
Tailwind Scrollbar Hide 1.1.7
Jest 29.7.0
Husky 8.0.3
Lint Staged 14.0.1

Getting Started

Install Dependencies

npm install

Install Husky

npm husky install

Start Dev Enviroment

npm run dev

View & Edit Project

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx & app/layout.tsx. The page auto-updates as you edit the file.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the latest features & issues @ the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

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.