Skip to content

Latest commit

 

History

History
202 lines (143 loc) · 7.93 KB

README.md

File metadata and controls

202 lines (143 loc) · 7.93 KB

Taste Treasury 🥘🍴

Your Ultimate Destination for Modern Restaurant Management!

🔗 Live Site:

🚀 Overview

Taste Treasury is a comprehensive platform designed to revolutionize restaurant management. It combines modern technology with an intuitive user interface to simplify tasks for both customers and administrators.

  • For Customers: Explore menus, place orders, and enjoy a seamless browsing experience with responsive design and a light/dark mode toggle.
  • For Administrators: Manage menus, track orders, and interact with customers through a dynamic admin panel equipped with secure tools and real-time updates.

With features like JWT-based authentication, engaging animations, and AI-driven future enhancements, Taste Treasury ensures a smarter, more efficient restaurant management experience.

Our mission? To empower the food industry with innovative tools, delivered in style. 🍽️

✨ Key Features

  • 🌟 Responsive Design for All Devices
    Seamlessly optimized for mobile, tablet, and desktop devices, providing a flawless experience across platforms.

  • 🔒 Secure User Authentication
    Effortless registration and login powered by Firebase, enhanced with JWT token-based authentication and cookie parsing for secure session management.

  • 🧠 Enhanced SEO with React Helmet
    Improve search engine visibility and metadata handling using React Helmet Async.

  • 🌗 Elegant Dark/Light Mode Toggle
    Switch effortlessly between dark and light themes to suit any time of day and user preference.

  • 💡 Engaging Animations
    Add vibrancy to the user experience with animations powered by React Awesome Reveal and Framer Motion.

  • 🚀 Smooth Scrolling Elements
    Experience seamless scrolling effects with React Fast Marquee, enriching page interactions.

  • 🛠️ Comprehensive Admin Tools
    Streamlined restaurant management with features for menu updates, order tracking, and customer engagement via a dynamic admin panel.

  • 📡 Secure API Calls with Axios
    Effortlessly communicate with the backend using Axios and Axios Secure for robust and reliable API requests.

  • 🎯 Future-Ready Features
    AI-driven recommendations and real-time updates, paving the way for smarter and faster restaurant management.

🚀 Tech Stack

  • Frontend: React.js, TailwindCSS (for sleek and responsive design)
  • Animations: Lottie React, React Awesome Reveal (for engaging motion effects)
  • Routing: React Router DOM (for smooth navigation)
  • Authentication: Firebase, JWT Tokens, Cookie Parsing
  • Backend: Express.js, MongoDB (for server-side functionality and data management)
  • API Communication: Axios, Axios Secure

🎮 How It Works

  1. Visit the Site: Explore the live platform to experience the ease of restaurant management.
  2. Sign Up/Login: Register securely using your email for full access.
  3. Toggle Between Light/Dark Themes: Customize your viewing experience with a single click.
  4. Manage Menus & Orders: Simplify day-to-day restaurant operations with powerful admin tools.
  5. Stay Tuned: Future updates will include seamless checkout options and AI-driven insights.

📦 Dependencies

Taste Treasury relies on the following libraries:

Dependency Version Description
@fortawesome/fontawesome-free ^6.7.2 Icon library for UI elements
axios ^1.7.9 Promise-based HTTP client
firebase ^11.1.0 Google Firebase SDK
framer-motion ^11.15.0 Library for animations
localforage ^1.10.0 Local storage wrapper for better offline support
match-sorter ^8.0.0 Sorting and filtering utility
moment ^2.30.1 Date and time manipulation library
react ^18.3.1 React framework for UI development
react-awesome-reveal ^4.3.1 Animation effects for React components
react-dom ^18.3.1 React rendering package
react-fast-marquee ^1.6.5 Smooth scrolling text/marquee component
react-helmet-async ^2.0.5 Manage document head (SEO support)
react-hot-toast ^2.4.1 Notifications and toast messages
react-icons ^5.4.0 Collection of icons for React
react-router-dom ^6.28.1 Routing for React applications
sort-by ^1.2.0 Sorting utility for JavaScript objects
swiper ^11.1.15 Mobile-friendly slider component
yet-another-react-lightbox ^3.21.7 Lightbox for displaying images

Install Dependencies To install dependencies manually, use:

npm install

Installation and Setup 🚀

  1. Clone the repository:

    git clone https://github.com/Abubokkor98/career-compass.git

  2. Navigate to the project directory:

    cd career-compass

  3. Install dependencies:

    npm install

  4. Set up Firebase:

    • Create a Firebase project at Firebase Console.
    • Enable Authentication and configure the desired sign-in methods.
    • Copy the Firebase configuration and create a .env file in the root directory.
    • Add the following variables: 
      REACT_APP_FIREBASE_API_KEY=your-firebase-api-key
REACT_APP_FIREBASE_AUTH_DOMAIN=your-firebase-auth-domain
REACT_APP_FIREBASE_PROJECT_ID=your-firebase-project-id
REACT_APP_FIREBASE_STORAGE_BUCKET=your-firebase-storage-bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your-firebase-messaging-sender-id
REACT_APP_FIREBASE_APP_ID=your-firebase-app-id

VITE_API_URL=your_backend_api_url

5. Start the development server:

npm start
  1. Access the application at http://localhost:5173.

💡 Roadmap and Future Features

  1. 💳 Payment Integration
    Enable smooth transactions with multiple payment gateways like Stripe and PayPal.

  2. 📈 AI-Based Insights
    Leverage AI to gain actionable insights into customer preferences and optimize your offerings.

  3. 🗣️ Multi-Language Support
    Reach global audiences with multilingual capabilities.

  4. 📦 Real-Time Inventory Updates
    Keep track of stock levels and availability in real time, minimizing downtime.

👥 Contribution and Support

We welcome contributions! Follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature-branch
  3. Make your changes and test them.
  4. Submit a pull request to the main branch.

🙋‍♂️ About the Developer

Built with 💻 and passion by Abu Bokkor Siddik.

🔥 Why Choose Taste Treasury?

  • 🛡️ Trusted by Restaurateurs
    Our platform is designed with restaurant owners in mind, ensuring reliability and scalability.

  • ⚡ Fast, Reliable, Secure
    Powered by modern tech for unparalleled performance and security.

  • 🌍 Global Vision
    Expanding to bring Taste Treasury to restaurants worldwide, with innovative features on the horizon.

🎯 Get Started Today!

Visit us at Taste Treasury Live to explore, manage, and elevate your restaurant operations effortlessly!