This document defines the conventions, file structure, and best practices to be followed
as./src/
├── api
│ ├── api.ts # API
├── components
│ └── # Reusable UI components
├── helper
│ └── # General-purpose helper functions
├── hooks
│ └── # Custom React hooks
├── lib
│ └── # Third-party libraries or wrappers
├── main.tsx # App entry point
├── pages
│ ├── App.module.css # Styles for the main App
│ └── App.tsx # Root component
├── services
│ └── # service layer
├── styles
│ └── # Global and shared styles
├── utils
│ └── # Utility functions
└── vite-env.d.ts # TypeScript definitions for Vite
- Use CamelCase (PascalCase) for function names.
eg-
function FetchUserProfile() { ... }
function HandleLoginResponse() { ... }Here is the updated README.md for your exp-file project, now including the full folder structure under ./src/:
- Use smallCamel (camelCase) for variable names.
let userToken: string;
const isProfileComplete = true;- Use kebab-case for file and class names.
- Prefer CSS Modules for component styles.
/* App.module.css */
.header-container { ... }
.login-form__input--focused { ... }- Use kebab-case for folder and file names.
- Group logically related files in folders.
components/
└── user-card/
├── user-card.tsx
└── user-card.module.css- DRY: Don’t Repeat Yourself.
- Modularize: Component, Logic, API, Utility separation.
- Use TypeScript for all files (
.tsx/.ts). - Write meaningful commit messages.