diff --git a/.docs/PROJECT-STRUCTURE.md b/.docs/PROJECT-STRUCTURE.md index 239f51b..628ac31 100644 --- a/.docs/PROJECT-STRUCTURE.md +++ b/.docs/PROJECT-STRUCTURE.md @@ -1,57 +1,57 @@ -# Project File Stucture +# Project File Structure -This ASCII tree represents the Project Stucture. Read through the comments to know about the Project Stucture. +This ASCII tree represents the project structure. Read through the comments to learn more about the walking-pal-web repo. ```sh . -├── .docs #contains all markdown files and assets used to write the documentation files. -├── assets/ #contains assets used in the WebApp +├── .docs #markdown files and assets used to write the documentation files +├── assets/ #assets used throughout walking-pal-web │ ├── gif/ -│ │ ├── some-gif.gif #All gif, png, svg names must be in kebab-case -│ │ ├── index.ts #This imports all the gif files in the `gif/` directory and exports them. +│ │ ├── some-gif.gif #gif, png, svg names must be in kebab-case +│ │ ├── index.ts #imports all the gif files in the `gif/` directory and exports them │ │ └── ...(other gifs) │ ├── png │ └── svg -├── components/ #contains global components (used by more than one pages) +├── components/ #global components (used by more than one page) │ ├── GlobalComponent1/ -│ │ ├── GlobalComponent1.tsx #Component files are in PascalCase -│ │ ├── global-component1.module.scss #SCSS files are in kebab-case -│ │ ├── index.ts #this file re-exports the React Component from GlobalComponent1.tsx (along with any other accompanied exports) -│ │ └── componentUtility.ts #this might have any utility function used by the GlobalComponent1 React Component +│ │ ├── GlobalComponent1.tsx #component file names are in PascalCase +│ │ ├── global-component1.module.scss #SCSS file names are in kebab-case +│ │ ├── index.ts #re-exports the React component from GlobalComponent1.tsx (along with any other accompanied exports) +│ │ └── componentUtility.ts #utility function used by the GlobalComponent1 React component │ └── GlobalComponent2/ -├── hooks/ #contains global custom hooks (used by more than one pages) +├── hooks/ #global custom hooks (used by more than one page) │ └── useWindowResize.ts ├── pages/ -│ ├── api/ #contains our Nextjs api endpoints -│ │ ├── route1/ #this is route1 endpoint +│ ├── api/ #Nextjs API endpoints +│ │ ├── route1/ #route1 endpoint │ │ │ └── index.pg.ts #route1 endpoint logic -│ │ ├── utils/ #miscellaneous utilites used by endpoints -│ │ └── index.pg.ts #contains root (/) endpoint handler +│ │ ├── utils/ #miscellaneous utilities used by endpoints +│ │ └── index.pg.ts #root (/) endpoint handler │ ├── page-name1/ -│ │ ├── components/ #contains local components (used by PageName1 page only) +│ │ ├── components/ #local components (used by PageName1 page only) │ │ │ ├── LocalComponent1/ -│ │ │ │ ├── LocalComponent1.tsx #Component file name is in PascalCase -│ │ │ │ ├── local-component.module.scss #SCSS file name is in kebab-case -│ │ │ │ └── index.ts #this file re-exports the React Component from LocalComponent.tsx +│ │ │ │ ├── LocalComponent1.tsx #component file names are in PascalCase +│ │ │ │ ├── local-component.module.scss #SCSS file names are in kebab-case +│ │ │ │ └── index.ts #re-exports the React component from LocalComponent.tsx │ │ │ └── LocalComponent2/ -│ │ ├── page-name1.module.scss #this single scss file is used by all local components in the Page -│ │ ├── PageName1.tsx #Contains the PageName1 Component -│ │ ├── index.pg.ts #re-exports PageName1 Component as a "default export" +│ │ ├── page-name1.module.scss #this single SCSS file is used by all local components in the page +│ │ ├── PageName1.tsx #PageName1 component +│ │ ├── index.pg.ts #re-exports PageName1 component as a "default export" │ │ └── hooks/ #contains local custom hooks (used by PageName1 page only) │ ├── page-name2/ -│ ├── _app.pg.ts #contains WebApp's root App component +│ ├── _app.pg.ts #walking-pal-web's root App component │ ├── _document.pg.ts #ref- https://nextjs.org/docs/advanced-features/custom-document │ ├── _global.scsss #contains global styles. (Rarely used) -│ └── 404.pg.ts #our custom 404 error page -├── public/ #Do not put or edit any files inside this +│ └── 404.pg.ts #custom 404 error page +├── public/ #do not add or edit any files inside this ├── theme/ -│ ├── WPThemeProvider.tsx #our Theme Provider component -│ ├── theme.ts #generates our themes for components. Strictly follow STYLE-GUIDE.md when editing this. +│ ├── WPThemeProvider.tsx #Theme Provider component +│ ├── theme.ts #generates themes for components. Strictly follow STYLE-GUIDE.md when editing this │ └── index.ts #re-exports everything from WPThemeProvider.tsx -├── types/ #contians global TypeScript types +├── types/ #global TypeScript types ├── utils/ #miscellaneous utilities ├── .gitignore └── package.json ``` -**Credits**: This ASCII tree is generated using [tree.nathanfriend.io]() +**Credits**: This ASCII tree was generated using [tree.nathanfriend.io]()