Giter Club home page Giter Club logo

restaurantlistingclient's Introduction

Restaurant Listing App

This project is a ReactJS application that displays a categorized list of restaurants based on their location states. The application fetches restaurant data from a provided API endpoint and presents it in a user-friendly format.

Project Structure

Server-side (ExpressJS)

The server-side code resides in the proxy-server folder. It utilizes ExpressJS to set up a middleware for CORS handling and defines a route to fetch restaurant data from the provided API endpoint.

Client-side (ReactJS)

The client-side code is located in the client folder. It's a ReactJS application that utilizes React Router to navigate between different views/components. The main components include:

  • Home: Displays the homepage
  • RestaurantList: Displays the list of restaurants
  • About: About page
  • NotFound: 404 error page

Getting Started

Prerequisites

  • Node.js
  • npm or yarn

Installation

  1. Clone this repository.
  2. Navigate to the proxy-server folder and run npm install to install server dependencies.
  3. Navigate to the client folder and run npm install to install client dependencies.

Running the Application

  1. Start the server:

    cd proxy-server
    npm start
    

    The server will run on port 5000.

  2. Start the client:

    cd client
    npm start
    

    The React app will run on port 3000.

API Integration

The Express server fetches restaurant data from the provided API endpoint: https://nextjs-orpin-omega-98.vercel.app/api/restaurants

Deployment

The application is deployed on Vercel and accessible via a public URL provided by Vercel.

Testing

API testing can be performed using tools like Postman or curl before integrating it into the application.

Code Sharing

The project is available on GitHub at repository link. The repository is public and accessible to view the codebase.

Expected Output

The homepage of the application lists restaurants under categorized subtitles based on their locations, following a format similar to:

New York:
- Restaurant 1
- Restaurant 2
- Restaurant 3

Texas:
- Restaurant 4
- Restaurant 5
- Restaurant 6

Notes

  • The application is designed to be responsive and user-friendly.
  • Emphasis has been placed on maintaining clean and maintainable code practices.

Feel free to tailor the content to better fit your project's specifics and add more details or sections as needed. Adjust the placeholders like the repository link with the actual URLs and information specific to your deployment.

restaurantlistingclient's People

Contributors

tomz10105 avatar

Watchers

 avatar

restaurantlistingclient's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.