Git Product home page Git Product logo

food_truck's Introduction

Food Truck Application

Project Overview

This Food Truck application serves as a full-stack project built with React, Node.js, and Elasticsearch. It's designed to showcase real-time data interaction with a map interface, where users can find food trucks in a city, explore their menus, and locate them on the map.

Prerequisites

  • Docker
  • Node.js (v18.17.0)
  • NPM

Installation and Local Development

  1. Clone the repository:

    git clone https://github.com/yourusername/foodtruck-app.git
    cd foodtruck-app
  2. Navigate to the app directory:

    cd food_truck/app
  3. Install dependencies:

    npm install
  4. Build the project:

    npm run build
  5. Start the application locally:

    npm start

    This command will start the backend server on http://localhost:3000 and will also serve the frontend.

Docker Deployment

  1. Build the Docker image:

    docker build -t dva89/foodtruck-app .
  2. Run the Docker containers:

    docker-compose up

    This will start both the application and the Elasticsearch service as defined in the docker-compose.yml.

Project Structure

/food-truck-app
|-- /src
|   |-- /client       # Client-specific code (React, CSS)
|   |   |-- components  # React components
|   |   |-- App.js
|   |   |-- index.js
|   |-- /server       # Server-specific code (Express, GraphQL)
|   |   |-- api       # API logic and controllers
|   |   |-- config    # Server config files
|   |   |-- routes    # Defines all routes and their controllers
|   |   |-- services  # Backend service logic, e.g., interacting with Elasticsearch
|-- /public           # Static files and compiled output
|-- /config           # Configuration files like Webpack
|-- /scripts          # Scripts for building and running the project
|-- package.json      # Node project dependencies and scripts
|-- Dockerfile
|-- docker-compose.yml
|-- README.md

Important Notes

  • Ensure Docker is correctly installed and configured on your machine before attempting to run the Docker commands.
  • The application uses a mocked backend for demonstration purposes; adjust the data endpoints for production use.

This README provides a concise yet comprehensive guide to getting the Food Truck application running on your local development machine and using Docker for deployment.

food_truck's People

Contributors

dante-vonarmia avatar

Watchers

 avatar

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.