commit 996c5389d4e2e498c426448eefdde37c8b90eac5 Author: karimalden Date: Mon Jun 10 11:00:52 2024 +0300 first commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..29b20f0 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +### Directory Descriptions: + +- **public/**: Contains static assets like HTML files and images. +- **src/**: The main source code directory. + + - **assets/**: Static assets like images, fonts, etc. + - **components/**: Reusable UI components. + - **types/**: TypeScript type definitions. + - **enums/**: Enumerations or constants. + - **pages/**: Components representing different pages. + - **hooks/**: Custom React hooks. + - **lib/**: Utility functions or helper modules. + - **Redux/**: Redux-related code (actions, reducers, etc.) if used. + - **styles/**: Global styles or shared styles. + - **translate/**: Files related to localization and translation. + - **layout/**: Components or files related to the overall layout structure. + - **Layout.js**: Example layout component. + - **Routes.tsx**: File for defining your application routes. + - **App.js**: The main component and entry point. + - **index.js**: Entry point for rendering the React app. + +- **.gitignore**: Specifies files or directories to be ignored by version control. +- **package.json**: Metadata about the project, dependencies, and scripts. + +## Getting Started + +### Prerequisites + +- Node.js and npm installed +- v20.10.0 + +### Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/KarimAldeen/Start-React-ts.git + ``` + + ```bash + cd Start-React-ts + ``` + +2. Install dependencies: + + ```bash + pnpm i + ``` + +### Usage + +Start the development server: + +```bash + +pnpm start + +``` + +# ecommerce_dm