front init
This commit is contained in:
@@ -1,23 +1,13 @@
|
||||
# Next.js + Feature-Sliced Design | Pure Template
|
||||
# Coffee Project Frontend
|
||||
|
||||
## IMPORTANT
|
||||
Next.js application structured with Feature-Sliced Design and configured to run with Bun.
|
||||
|
||||
Do not delete the pages\* folder even if you are using App Router, deleting the pages folder
|
||||
will result in a [build error](https://t.me/feature_sliced/1/107414).
|
||||
## Notes
|
||||
|
||||
In WebStorm you can mark a directory as [excluded](https://www.jetbrains.com/help/webstorm/configuring-project-structure.html#content-root). After that, you won’t see it in shared files (like, for example, node_modules or .next)
|
||||
- Keep the `pages` folder in the project root; removing it can cause a build error with Next.js.
|
||||
- Bun is the package manager: `bun install`, `bun dev`, `bun run build`, `bun run lint`.
|
||||
|
||||
## ADDITIONAL SOLUTION TO THE PROBLEM (NOT RECOMMENDED)
|
||||
|
||||
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
|
||||
## Folders
|
||||
|
||||
| Folder | Description |
|
||||
| ------------ | --------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -31,31 +21,8 @@ for example to "pagesLayer" and then delete the pages folder from the project ro
|
||||
| src/entities | Entities FSD Layer |
|
||||
| src/shared | Shared FSD Layer |
|
||||
|
||||
## Remove junk _.gitkeep_ files
|
||||
## Tooling
|
||||
|
||||
### 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\entities\.gitkeep
|
||||
del .\src\features\.gitkeep
|
||||
del .\src\shared\.gitkeep
|
||||
del .\src\widgets\.gitkeep
|
||||
del .\public\.gitkeep
|
||||
```
|
||||
|
||||
This template uses such development assistants
|
||||
|
||||
- Eslint
|
||||
- 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.
|
||||
|
||||
Reference in New Issue
Block a user