Skip to content

Commit

Permalink
feat: new directory: appComponents/
Browse files Browse the repository at this point in the history
  • Loading branch information
@SandroMiguel
SandroMiguel committed Oct 7, 2023
1 parent ec64e01 commit ae88263
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 38 deletions.
95 changes: 57 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ your-react-app/
│ │ | └── [OtherComponent].scss
│ │ ├── ...
│ │
│ ├── appComponents/
│ │ ├── index.js
│ │ ├── [SomeComponent]/
│ │ | ├── index.js
│ │ | ├── [SomeComponent].js
│ │ | └── [SomeComponent].scss
│ │ |
│ │ ├── [OtherComponent]/
│ │ | ├── index.js
│ │ | ├── [OtherComponent].js
│ │ | └── [OtherComponent].scss
│ │ ├── ...
│ │
│ ├── hooks/
│ │ ├── index.js
│ │ ├── use[SomeHook].js
Expand Down Expand Up @@ -81,44 +94,50 @@ your-react-app/

Files and folders overview.

| File/Folder | Description |
| --------------------------------------------------- | ------------------------------------------------------ |
| **public/** | Build output folder |
| **src/** | The source code of the application |
| src/**pages/** | Application pages |
| src/pages/**index.js** | Exports all pages |
| src/pages/**SomePage/** | Application page folder example |
| src/pages/SomePage/**index.js** | Re-exports the component |
| src/pages/SomePage/**SomePage.js** | Application page file example |
| src/pages/SomePage/**SomePage.scss** | CSS file for SomePage.js |
| src/**components/** | React components |
| src/components/**index.js** | Exports all components |
| src/components/**SomeComponent/** | React component folder example |
| src/components/SomeComponent/**index.js** | Re-exports the component |
| src/components/SomeComponent/**SomeComponent.js** | React component file example |
| src/components/SomeComponent/**SomeComponent.scss** | CSS file for SomeComponent.js |
| src/**hooks/** | Custom hooks |
| src/hooks/**index.js** | Exports all custom hooks |
| src/hooks/**useSomeHook.js** | Custom hook example |
| src/**config/** | Configurations |
| src/config/**routes.js** | React Router routes |
| src/**assets/** | Static resources (e.g. images, pdf, stylesheets, etc.) |
| src/assets/images/**index.js** | Exports all images |
| src/assets/images/**some-image.png** | Image file example |
| src/assets/**styles/** | CSS styles |
| src/assets/styles/**theme.css** | Application-wide theme configuration. |
| src/assets/styles/**shared.module.scss** | Shared styles across components |
| src/**utils/** | Helper files (e.g. error handlers, formatters, etc.) |
| src/utils/**someUtil.js** | Util file example |
| src/**index.js** | JS entry point for the application |
| **.gitignore** | Files and directories that Git should ignore |
| **.editorconfig** | IDE coding style |
| **.eslintrc.js** | ESLint configuration |
| **package.json** | Package configuration |
| **LICENSE** | License document |
| **README.md** | This document |
| **yarn.lock** | Dependencies information for Yarn |
| **AppRoutes.js** | Application routes |
| File/Folder | Description |
| ------------------------------------------------------ | ------------------------------------------------------ |
| **public/** | Build output folder |
| **src/** | The source code of the application |
| src/**pages/** | Application pages |
| src/pages/**index.js** | Exports all pages |
| src/pages/**SomePage/** | Application page folder example |
| src/pages/SomePage/**index.js** | Re-exports the component |
| src/pages/SomePage/**SomePage.js** | Application page file example |
| src/pages/SomePage/**SomePage.scss** | CSS file for SomePage.js |
| src/**components/** | Reusable React components |
| src/components/**index.js** | Exports all components |
| src/components/**SomeComponent/** | React component folder example |
| src/components/SomeComponent/**index.js** | Re-exports the component |
| src/components/SomeComponent/**SomeComponent.js** | React component file example |
| src/components/SomeComponent/**SomeComponent.scss** | CSS file for SomeComponent.js |
| src/**appComponents/** | Application-specific React components |
| src/appComponents/**index.js** | Exports all components |
| src/appComponents/**SomeComponent/** | React component folder example |
| src/appComponents/SomeComponent/**index.js** | Re-exports the component |
| src/appComponents/SomeComponent/**SomeComponent.js** | React component file example |
| src/appComponents/SomeComponent/**SomeComponent.scss** | CSS file for SomeComponent.js |
| src/**hooks/** | Custom hooks |
| src/hooks/**index.js** | Exports all custom hooks |
| src/hooks/**useSomeHook.js** | Custom hook example |
| src/**config/** | Configurations |
| src/config/**routes.js** | React Router routes |
| src/**assets/** | Static resources (e.g. images, pdf, stylesheets, etc.) |
| src/assets/images/**index.js** | Exports all images |
| src/assets/images/**some-image.png** | Image file example |
| src/assets/**styles/** | CSS styles |
| src/assets/styles/**theme.css** | Application-wide theme configuration. |
| src/assets/styles/**shared.module.scss** | Shared styles across components |
| src/**utils/** | Helper files (e.g. error handlers, formatters, etc.) |
| src/utils/**someUtil.js** | Util file example |
| src/**index.js** | JS entry point for the application |
| **.gitignore** | Files and directories that Git should ignore |
| **.editorconfig** | IDE coding style |
| **.eslintrc.js** | ESLint configuration |
| **package.json** | Package configuration |
| **LICENSE** | License document |
| **README.md** | This document |
| **yarn.lock** | Dependencies information for Yarn |
| **AppRoutes.js** | Application routes |

## Credits

Expand Down
Empty file added src/appComponents/OtherComponent/OtherComponent.js
View file
Empty file.
Empty file added src/appComponents/OtherComponent/OtherComponent.scss
View file
Empty file.
1 change: 1 addition & 0 deletions src/appComponents/OtherComponent/index.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from "./OtherComponent";
Empty file added src/appComponents/SomeComponent/SomeComponent.js
View file
Empty file.
Empty file added src/appComponents/SomeComponent/SomeComponent.scss
View file
Empty file.
1 change: 1 addition & 0 deletions src/appComponents/SomeComponent/index.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from "./SomeComponent";
4 changes: 4 additions & 0 deletions src/appComponents/index.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import SomeComponent from "./SomeComponent";
import OtherComponent from "./OtherComponent";

export { SomeComponent, OtherComponent };

0 comments on commit ae88263

Please sign in to comment.