royal-mushrooms-frontend

πŸ„ Royal Mushrooms - Premium Mushroom E-commerce Platform

🌿 Freshly Harvested Premium Mushrooms, Delivered to Your Door 🌿

Discover a world of flavor with our exquisite selection of organic and wild-foraged fungi


✨ Features

πŸ›’ E-commerce Functionality

πŸ‘€ User Experience

🎨 Modern Design

πŸš€ Tech Stack

πŸ“‹ Prerequisites

Before running this project, make sure you have:

⚑ Quick Start

1. Clone the Repository

git clone https://github.com/RavinduWanasinghe0524/royal-mushrooms-frontend.git
cd royal-mushrooms-frontend

2. Install Dependencies

npm install
# or
yarn install
# or
pnpm install
# or
bun install

3. Run the Development Server

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

4. Open Your Browser

Navigate to http://localhost:3000 to see the application in action! πŸŽ‰

πŸ“ Project Structure

royal-mushrooms-frontend/
β”œβ”€β”€ pages/
β”‚   β”œβ”€β”€ _app.js          # App wrapper with global styles
β”‚   β”œβ”€β”€ _document.js     # Custom document structure
β”‚   └── index.js         # Main homepage component
β”œβ”€β”€ styles/
β”‚   β”œβ”€β”€ globals.css      # Global CSS with Tailwind
β”‚   └── Home.module.css  # Component-specific styles
β”œβ”€β”€ public/
β”‚   └── [assets]         # Static assets (images, icons)
β”œβ”€β”€ tailwind.config.js   # Tailwind CSS configuration
β”œβ”€β”€ postcss.config.js    # PostCSS configuration
└── package.json         # Project dependencies

πŸ›οΈ Product Features

Premium Mushroom Selection

Shopping Experience

🎨 UI/UX Features

πŸ”§ Development Scripts

# Start development server
npm run dev

# Build for production
npm run build

# Start production server
npm start

# Run ESLint
npm run lint

🌐 Deployment

  1. Push your code to a Git repository
  2. Visit Vercel
  3. Import your repository
  4. Deploy with one click! πŸš€

Deploy on Netlify

  1. Build the project: npm run build
  2. Deploy the out folder to Netlify

Deploy on Traditional Hosting

  1. Run npm run build
  2. Upload the generated files to your web server

🀝 Contributing

We welcome contributions! Here’s how you can help:

  1. Fork the repository
  2. Create a 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 file for details.

πŸ“ž Support & Contact

πŸ™ Acknowledgments


πŸ„ Royal Mushrooms - Where Quality Meets Nature πŸ„

Β© 2024 Royal Mushrooms. All rights reserved.