Skip to content

NanuIjaz/front-end-develop

Repository files navigation

NextJS 14 Template

This is NextJS Template using version 14 that you can see the documentation here

Package / Library Included


Project Structure

Project structure for this Next starter

.husky                         // Contain husky configuration
.next                          // Contain Next framework configuration
.vscode                        // Contain vscode configuration to force local
node_modules                   // Contain modules / third parties
public                         // Contain public assets & etc
app                            // Entry point for the app.
├── {feature-name-folder}      // Contain your feature files, the the structure same as app folder (but isolated functionality)
├── layout.tsx                 // File for rendering layout (app layout)
├── loading.tsx                // File for rendering loading (app loading)
└── page.tsx                   // File for rendering page (app (/) main page)
components                     // Contain all base components or reusable
├── ui                         // Contain all reusable components
└── {another-component=folder} // Your desired reusable component folder name
constants                      // Contain all constants
styles                         // Contain all global styles
└── global.scss                // Contain global styles and tailwind styles
lib                            // Contain library config
└── utils.ts                   // Tailwind and shadcn merge config
.eslint.json                   // File config for eslint
.prettierrc                    // File config for prettier
commitlint.config.js           // File config for commitlint
next-env.d.ts                  // File config for type definition
next.config.js                 // File config for next framework
package.json                   // File config for your project
pnpm-lock.yaml                 // File config for locking project packages (READONLY FILE!)
postcss.config.js              // File config for postcss
README.md                      // File for documentation (HEY YOU READING ME NOW!)
tailwind.config.js             // File config for tailwind
components.json                // File config for shadcn components

Ref: Next Project Structure

If you want to create folder outside declared above, you can create, but, don't forget to update this docs.


Installation

1; Install dependencies using pnpm

pnpm install

Available commands for start and build

Run next app with turbopack

pnpm run dev:turbo

Build next app

pnpm run build

Available commands for linting

Run linter and will search for problems, but will not fix

pnpm lint

Run linter and will search and try to fix the problems.

pnpm lint:fix

Run linter and will call prettier to fix the code style.

pnpm lint:format

Commit Style

Please use commitizen format to commit for example you can see Here

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages