Skip to content

Commit 870c152

Browse files
committed
chore: add project layout structure on readme
1 parent d49674a commit 870c152

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
<p align="center">
1212
<a href="#key-features">Key Features</a> •
1313
<a href="#how-to-use">How To Use</a> •
14-
<a href="#credits">Credits</a> •
14+
<a href="#how-to-use">How To Use</a> •
15+
<a href="#application-structure">Application Structure</a> •
1516
<a href="#license">License</a>
1617
</p>
1718

@@ -78,6 +79,41 @@ $ yarn build
7879

7980
```
8081

82+
## Application structure
83+
84+
> The directory layout of this boilerplate
85+
86+
.
87+
├── .vscode # Vscode config, for autoformat on save.
88+
├── build # After running the build command the build files get put here
89+
├── node_modules # NPM dependency folder
90+
├── public # Reacts public folder for the html and static assets
91+
├── src # Source directory for the React Application
92+
├── src # Source directory for the React Application
93+
│ │
94+
│ ├── api # API async functions folder.
95+
│ ├── assets # Static assets folder for the global scope. Example: images, icons, fonts etc.
96+
│ ├── components # Typical React component folder but only for global components.
97+
│ ├── config # App config (More details inside the folder)
98+
│ ├── features # Features pattern folder for Application features (More details inside the folder)
99+
│ ├── lib # Global helper functions and custom hooks folder
100+
│ ├── pages # Pages component folder
101+
│ ├── router # Application navigation/routing config (More details inside the folder)
102+
│ ├── services # Folder for services like custom axios instance, analytics etc.
103+
│ ├── store # Application Redux store
104+
│ ├── styles # Custom SC components, CSS, less utilities
105+
│ └── App.js # Entry component for the React App.
106+
107+
├── craco.config.js # Extend Webpack config (example: Ant Design theme variable modifying)
108+
├── jsconfig.json # Adjust file paths to use absolute file path for React
109+
├── package.json # The NPM config file for all the packages installed and scripts and more
110+
├── .env # Store API Url, Secret API keys etc
111+
├── .eslintrc # Configure Eslint
112+
├── .eslinignore # ignore certain files for Eslint
113+
├── .gitignore # ignore certain files for git (example: .env)
114+
├── .prettierrc # Configure prettier (example: .env)
115+
└── .prettierignore # ignore certain files for Prettier
116+
81117
## Credits
82118

83119
This software uses the following open source packages:

0 commit comments

Comments
 (0)