diff --git a/README.md b/README.md index ebdd377..071f03e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/src/appComponents/OtherComponent/OtherComponent.js b/src/appComponents/OtherComponent/OtherComponent.js new file mode 100644 index 0000000..e69de29 diff --git a/src/appComponents/OtherComponent/OtherComponent.scss b/src/appComponents/OtherComponent/OtherComponent.scss new file mode 100644 index 0000000..e69de29 diff --git a/src/appComponents/OtherComponent/index.js b/src/appComponents/OtherComponent/index.js new file mode 100644 index 0000000..92e34ec --- /dev/null +++ b/src/appComponents/OtherComponent/index.js @@ -0,0 +1 @@ +export { default } from "./OtherComponent"; diff --git a/src/appComponents/SomeComponent/SomeComponent.js b/src/appComponents/SomeComponent/SomeComponent.js new file mode 100644 index 0000000..e69de29 diff --git a/src/appComponents/SomeComponent/SomeComponent.scss b/src/appComponents/SomeComponent/SomeComponent.scss new file mode 100644 index 0000000..e69de29 diff --git a/src/appComponents/SomeComponent/index.js b/src/appComponents/SomeComponent/index.js new file mode 100644 index 0000000..ca594ca --- /dev/null +++ b/src/appComponents/SomeComponent/index.js @@ -0,0 +1 @@ +export { default } from "./SomeComponent"; diff --git a/src/appComponents/index.js b/src/appComponents/index.js new file mode 100644 index 0000000..224bf50 --- /dev/null +++ b/src/appComponents/index.js @@ -0,0 +1,4 @@ +import SomeComponent from "./SomeComponent"; +import OtherComponent from "./OtherComponent"; + +export { SomeComponent, OtherComponent };