Shree Madhur (Demo)

A demo website built with Next.js, TypeScript & React

🚀 Table of Contents

• About
• Demo / Live Site
• Features
• Getting Started
• Folder Structure
• Tech Stack
• How to Contribute
• License

About

Shree Madhur is a demo website showcasing modern web development practices using Next.js with TypeScript.
It has modular components, custom hooks, global styles, and uses public assets for images/static files.

Demo / Live Site

Check out the live version here: demo-shree-madhur.vercel.app

Features

• Built with Next.js + TypeScript
• Modular component design
• Custom hooks for reusable logic
• Global & component-level styling (CSS / possibly styled components)
• Static/public assets served via public/ folder
• Responsive design

Getting Started

1. Clone the repo

   git clone https://github.com/Gourav-512/DEMO-SHREE-MADHUR.git
   cd DEMO-SHREE-MADHUR

2. Install dependencies If using npm:

   npm install

   Or if pnpm:

   pnpm install

3. Run in development mode

   npm run dev
   # or
   pnpm dev

4. Build for production

   npm run build
   npm start
   # or with pnpm
   pnpm build
   pnpm start

Folder Structure

/app          → Main application & routing  
/components   → Reusable UI components  
/hooks        → Custom React hooks  
/lib          → Utility functions  
/public       → Static assets (images, icons, etc.)  
/styles       → Global & component-level CSS  
next.config.mjs → Next.js configuration  
package.json   → Project metadata & dependencies  
tsconfig.json  → TypeScript configuration  
postcss.config.mjs → PostCSS configuration  

Tech Stack :-

• Framework: Next.js
• Language: TypeScript & JavaScript
• Styling: CSS (or Tailwind/PostCSS if added)
• Bundler / Build Config: Next.js config, PostCSS
• Hosting / Deployment: Vercel

How to Contribute

1. Fork the repo

2. Create a branch

   git checkout -b feature/YourFeature

3. Make changes & commit

   git commit -m "Add some feature"

4. Push branch

   git push origin feature/YourFeature

5. Open a Pull Request

License

This project is licensed under the MIT License. You are free to use, modify, and distribute it with attribution.