Skip to content

agleymelo/food-explorer-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Food Explorer WEB 🍴

License Languages Repo Size

Made by Agley Last Commit

Overview

Welcome to Food Explorer, the backbone of a revolutionary digital menu system developed as the final challenge for Rocketseat's program. Food Explorer is designed to provide a seamless and exceptional experience for managing restaurant menus and orders, aiming to enhance operational efficiency and customer satisfaction.

Technologies Used 💻

  • React: A JavaScript library for building user interfaces, offering a fast and interactive experience.
  • Styled-components: A CSS-in-JS library for styling React components, enabling easy maintenance and customization.
  • Keen-slider: A lightweight (10KB gzipped) and fully customizable slider/carousel library for React applications.
  • Axios: A promise-based HTTP client for making requests to server endpoints, facilitating seamless communication between the front-end and back-end.

Objective 🪧

The primary goal of Food Explorer is to streamline restaurant operations and enhance the overall customer experience through advanced digital menu management and order handling. Key objectives include:

  • User Management: Enable users to register, log in, and manage their profiles securely, ensuring personalized interactions.
  • Interactive Menu: Provide an intuitive and visually appealing digital menu interface for customers to explore available dishes, view detailed descriptions and ingredients, and make informed decisions.
  • Order Management: Facilitate efficient order processing, tracking, and management, ensuring timely delivery and customer satisfaction. This includes features such as order status updates and order history for users.

Live Demo 🌐

To explore the live demo of Food Explorer, you can visit Food Explorer Demo.

Demo Credentials:

Please note that this is a demo environment, and the data might be reset periodically.

Getting Started 🚀

Prerequisites

Before running the project, ensure you have the following prerequisites installed on your machine:

  • Node.js: Download and install Node.js from here. It's recommended to use the LTS version.
  • Git: Install Git from here if you haven't already.

Installation

  1. Clone the repository to your local machine:
git clone https://github.com/agleymelo/food-explorer-web.git
  1. Navigate to the project directory:
cd food-explorer-web
  1. Install dependencies using npm or yarn:
# Using npm
npm install

# Using yarn
yarn

Configuration ⚙️

  1. Create a .env file in the root directory based on the .env.example file provided.

  2. Configure the necessary environment variables such as VITE_BASE_URL

    • Create a .env file as shown in the .env.example file at the root of the project and configure the necessary environment variables. For example:
    VITE_BASE_URL=

Running the Serve 🚧

Start the server using the following command:

# Using npm
npm run dev

# Using yarn
yarn dev

Contribution

Contributions are welcome! Feel free to submit bug reports, feature requests, or pull requests to help improve this project.

License

This project is licensed under the MIT License.

Made with ❤️ by Agley

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published