From c12d8bebbe6b8245a0c3bbd3c2d2922b6157a203 Mon Sep 17 00:00:00 2001
From: "tejas.prakash" <tejas.prakash@tech4biz.io>
Date: Thu, 14 Aug 2025 13:08:52 +0530
Subject: [PATCH] Updated README

---
 README.md | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 128 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index e215bc4..38dca7c 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,51 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# CodeNuk Frontend
 
-## Getting Started
+A modern web application built with Next.js 14, TypeScript, and shadcn/ui. This project serves as the frontend for the CodeNuk platform, providing a user interface for generating and managing code projects.
 
-First, run the development server:
+## 🚀 Features
+
+- **Project Generation**: Create new projects with various templates
+- **Authentication**: Secure user authentication flows
+- **UI Components**: Built with shadcn/ui for a consistent design system
+- **Responsive Design**: Works on all device sizes
+- **Modern Stack**: Next.js 14, TypeScript, and Tailwind CSS
+
+## 🛠️ Prerequisites
+
+- Node.js 18.0.0 or later
+- npm or yarn package manager
+- Git
+
+## 🚀 Getting Started
+
+### 1. Clone the repository
+
+```bash
+git clone https://github.com/your-username/codenuk-frontend.git
+cd codenuk-frontend
+```
+
+### 2. Install Dependencies
+
+```bash
+npm install
+# or
+yarn install
+# or
+pnpm install
+```
+
+### 3. Environment Setup
+
+Create a `.env.local` file in the root directory and add the necessary environment variables:
+
+```env
+NEXT_PUBLIC_API_URL=your_api_url_here
+NEXT_PUBLIC_APP_URL=http://localhost:3000
+# Add other environment variables as needed
+```
+
+### 4. Run the Development Server
 
 ```bash
 npm run dev
@@ -10,15 +53,92 @@ npm run dev
 yarn dev
 # or
 pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000) in your browser to see the application running.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## 🎨 Adding shadcn/ui Components
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+This project uses shadcn/ui for UI components. Here's how to add new components:
+
+1. Install the shadcn CLI:
+   ```bash
+   npx shadcn-ui@latest init
+   ```
+
+2. Add a new component:
+   ```bash
+   npx shadcn-ui@latest add button
+   ```
+
+3. Import and use the component in your code:
+   ```tsx
+   import { Button } from "@/components/ui/button"
+   
+   export function MyComponent() {
+     return <Button>Click me</Button>
+   }
+   ```
+
+## 📁 Project Structure
+
+```
+src/
+├── app/                    # App router
+│   ├── auth/              # Authentication pages
+│   ├── components/        # Page-specific components
+│   ├── layout.tsx         # Root layout
+│   └── page.tsx           # Home page
+├── components/            # Reusable components
+│   ├── ui/               # shadcn/ui components
+│   └── ...
+├── lib/                   # Utility functions
+└── styles/                # Global styles
+```
+
+## 🧪 Testing
+
+Run the test suite:
+
+```bash
+npm run test
+# or
+yarn test
+```
+
+## 🏗️ Building for Production
+
+1. Build the application:
+   ```bash
+   npm run build
+   ```
+
+2. Start the production server:
+   ```bash
+   npm run start
+   ```
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- [Next.js](https://nextjs.org/)
+- [shadcn/ui](https://ui.shadcn.com/)
+- [Tailwind CSS](https://tailwindcss.com/)
+
+---
+
+Made with ❤️ by Tech4Biz
 
 ## Learn More