https://github.com/brightness999/restaurant_menu_api

https://github.com/brightness999/restaurant_menu_api

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/brightness999/restaurant_menu_api
• Owner: Brightness999
• Created: 2023-09-28T08:33:24.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-28T09:16:55.000Z (about 1 year ago)
• Last Synced: 2023-09-28T10:52:45.308Z (about 1 year ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Restaurant Menu API

This repository contains a simple GraphQL API for a restaurant menu application. The API is built using Node.js and Express, and it provides data for various menu categories.

## Getting Started

Follow these instructions to run the API locally on your machine.

### Prerequisites

Make sure you have the following installed on your machine:

- Node.js (https://nodejs.org/)

- npm (Node.js package manager, comes with Node.js)

### Installation

1. **Clone the repository to your local machine.**

   ```bash

   git clone https://github.com/Brightness999/Restaurant_menu_api.git

   ```

2. **Navigate to the project directory.**

   ```bash

   cd restaurant-menu-api

   ```

3. **Install the dependencies.**

   ```bash

   npm install

   ```

### Running the API

1. **Start the GraphQL server.**

   ```bash

   node index.js

   ```

   The server will start running on http://localhost:3000/graphql.

2. **Open your web browser and go to http://localhost:3000/graphql to access the GraphQL Playground.**

## Testing Queries

Use the GraphQL Playground to test queries and explore the available menu data.

1. In the left panel, write and run queries. For example:

   ```graphql

   query {

     getAppetizers {

       name

       price

     }

   }

   ```

2. Click the "Play" button or press `Ctrl + Enter` to execute the query.

3. Explore other queries such as `getEntrees`, `getSandwiches`, etc.

## Customization

Feel free to customize the API or extend its functionality. You can modify the data structure, add mutations, or connect the API to a real database.

## Additional Notes

- The menu data is currently stored in a local state for demonstration purposes. In a real-world scenario, you would connect the API to a database for persistent storage.

- If you encounter any issues or have questions, please reach out to [email protected].

---

**Note:** This is a simple example, and in a production environment, you would need to consider security, error handling, and other best practices.