Skip to content

mks1313/project-3-client

Repository files navigation

🍽️ Restaurant Web Application Frontend - MERN Project "Nyam Nyam"

This is the frontend component of the Restaurant Web Application project, named "Nyam Nyam." It is built using React and provides the user interface and client-side logic required for interacting with the backend API.

🌟 Project Overview

The frontend of this project allows users to interact with the application, view restaurants, leave comments, rate establishments, and manage their profiles. Restaurant owners can also manage their listings and view feedback from users.

🛠️ Technologies Used

  • React: JavaScript library for building user interfaces.
  • Vite: Build tool that provides a fast development environment and optimized production builds.
  • FontAwesome: Library for scalable vector icons and social logos.
  • axios: Library for making HTTP requests to the backend API.
  • Cloudinary: Used for handling and displaying images.
  • Payload: Content management system for managing data (if applicable on the frontend).
  • jsonwebtoken (JWT): For managing authentication tokens (if applicable on the frontend).
  • bcrypt: For password hashing (if applicable on the frontend).

🎨 Styles and CSS

  • Tailwind CSS: Utilized for utility-first styling, enabling rapid design with predefined classes.
  • Custom Styles: Additional custom CSS is written for specific components to achieve unique visual effects and layouts.

🚀 Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone [URL_DEL_REPOSITORIO_FRONTEND]
  2. Navigate to the project directory:

    cd [NOMBRE_DEL_DIRECTORIO]
  3. Install dependencies:

    npm install
  4. Set up environment variables: Create a .env file in the root directory and add your configuration. Example .env file:

    VITE_API_BASE_URL=http://localhost:3000/api
    VITE_CLOUDINARY_URL=your_cloudinary_url
  5. Run the development server:

    npm run dev
  6. Access the application: Open http://localhost:3000 in your browser.

📦 Deployment

The frontend is deployed and accessible via Vercel. Check the deployment status and logs on the Vercel dashboard.

📝 License

This project is licensed under the MIT License. See the LICENSE file for more details.

👤 Author

Maksim Georgiev Marinov - mks1313

📧 Contact

Feel free to reach out if you have any questions or feedback.

🌐 Visit the Application

You can access the application at: Nyam Nyam