From 0d5dfca3b6b941c82fb5d016c71c388e546dff5f Mon Sep 17 00:00:00 2001 From: Adefarati22 Date: Sat, 12 Jul 2025 21:11:54 +0100 Subject: [PATCH] Update README.md --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7059a96..ffa05d5 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,34 @@ -# React + Vite +# ๐Ÿ› ๏ธ My First React Project -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +Welcome to my first React.js project! This application was built as part of my learning journey into modern frontend development using **React** and **Tailwind CSS**. It includes features like form validation, routing, sidebar navigation, responsive layouts, and user interactions. -Currently, two official plugins are available: +> โš ๏ธ **Disclaimer**: +> This project is strictly for **educational and personal learning purposes**. +> It is **not intended for production** or commercial use. -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +--- + +## ๐Ÿš€ What I Learned + +- ๐Ÿงฑ React component structure +- ๐Ÿงญ React Router for navigation +- ๐Ÿงช Form validation using `react-hook-form` and `zod` +- ๐ŸŽจ Styling with Tailwind CSS +- ๐Ÿ’ก Lazy loading using `React.lazy` and `Suspense` +- ๐Ÿ“ฑ Responsive UI with mobile sidebar toggle +- ๐Ÿ” Basic auth flow using mock API +- ๐Ÿงฐ State management with React hooks (`useState`, `useEffect`, etc.) + +--- + +## ๐Ÿงฐ Tech Stack + +- **React** +- **Tailwind CSS** +- **React Router** +- **React Hook Form + Zod** +- **Axios** +- **Remix Icons** +- **Sonner** (for toast notifications) -## Expanding the ESLint configuration -If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.