Files
main_frontend/README.md
T
Dmitriy Bratchikov b1d3e89988 Update README.md
2024-05-27 19:48:34 +07:00

2.8 KiB
Raw Blame History

Next.js + Feature-Sliced Design | Pure Template

IMPORTANT

Do not delete the pages* folder even if you are using App Router, deleting the pages folder will result in a build error.

In WebStorm you can mark a directory as excluded. After that, you wont see it in shared files (like, for example, node_modules or .next)

If you don't like the empty "pages" folder in the project root, you can rename the pages layer (./src/pages) for example to "pagesLayer" and then delete the pages folder from the project root (you will also have to change path aliases in tsconfig and similar).

Use what you like best <3


Folders description

Folder Description
app Next App folder for App Routing
pages * Next Pages folder for Pages Routing
public Public files
src/app App FSD Layer
src/pages Pages FSD Layer
src/widgets Widgets FSD Layer
src/features Features FSD Layer
src/entities Entities FSD Layer
src/shared Shared FSD Layer

Remove junk .gitkeep files

UNIX

rm -rf .src/app/.gitkeep .src/entities/.gitkeep .src/features/.gitkeep .src/shared/.gitkeep .src/widgets/.gitkeep ./public/.gitkeep

WINDOWS

del .\src\app\.gitkeep
del .\src\entities\.gitkeep
del .\src\features\.gitkeep
del .\src\shared\.gitkeep
del .\src\widgets\.gitkeep
del .\public\.gitkeep

This template uses such development assistants

  • Eslint
  • Prettier
  • Stylelint
  • Jest

If you don't need it, you can disable it at any time by removing the dependency from your package.json and .*rc file.