From 7dde292fe68dc310181e30a4bf28c60c60b809af Mon Sep 17 00:00:00 2001 From: Dmitriy Bratchikov Date: Mon, 27 May 2024 16:25:05 +0700 Subject: [PATCH] fix: pageLayer explanation --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 545b092..3b5e54f 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,31 @@ # Next.js + Feature-Sliced Design | Pure Template ## Folders description -| Folder | Description | -|--------------|-----------------------------------------------------------------------------------------------------------------| -| app | Next App folder for [App Routing](https://nextjs.org/docs/app/building-your-application/routing#the-app-router) | -| 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 | +| Folder | Description | +|-----------------|-----------------------------------------------------------------------------------------------------------------| +| app | Next App folder for [App Routing](https://nextjs.org/docs/app/building-your-application/routing#the-app-router) | +| public | Public files | +| src/app | App FSD Layer | +| src/pagesLayer* | Pages FSD Layer | +| src/widgets | Widgets FSD Layer | +| src/features | Features FSD Layer | +| src/entities | Entities FSD Layer | +| src/shared | Shared FSD Layer | +* **pagesLayer**, not **pages** because _*pages*_ is a reserved name for [Pages Router](https://nextjs.org/docs/pages) and an error occurs during [assembly](https://t.me/feature_sliced/1/107414). ## Remove junk _.gitkeep_ files ### UNIX + ```bash rm -rf .src/app/.gitkeep .src/entities/.gitkeep .src/features/.gitkeep .src/shared/.gitkeep .src/widgets/.gitkeep ./public/.gitkeep ``` ### WINDOWS + ```bash -del .\src\app\.gitkeep +del .\src\app\.gitkeep del .\src\entities\.gitkeep del .\src\features\.gitkeep del .\src\shared\.gitkeep @@ -32,10 +35,9 @@ del .\public\.gitkeep This template uses such development assistants -* Eslint -* Prettier -* Stylelint +- Eslint +- Prettier +- Stylelint - -If you don't need it, you can disable it at any time by removing the -dependency from your _package.json_ and _.*rc_ file. +If you don't need it, you can disable it at any time by removing the +dependency from your _package.json_ and _.\*rc_ file.