FoodDash

FoodDash is a short-form video food delivery platform (similar to Instagram Reels + Swiggy).

This repository contains both the frontend and backend architectures for the platform.

Project Structure

• backend/: A Modular Monolith Go application using Gin, PostgreSQL, and Redis. Designed for high scalability and easy future extraction into independent microservices.
• frontend/: A Feature-First Flutter frontend application for the FoodDash platform.
• docs/: System documentation
• docker-compose.yml: Global docker-compose file (if you have one in the root, or you can use the backend's compose file).

Prerequisites

• Git
• Docker & Docker Compose
• Go 1.25+ (For running backend locally without Docker)
• Air (Optional, for backend hot-reloading)

Getting Started

1. Clone the repository

git clone https://github.com/your-username/FoodDash.git
cd FoodDash

2. Environment Setup

Setup the environment variables for the backend:

cd backend
cp .env.example .env

3. Running the Project

Option A: Using Docker (Recommended)

You can spin up the backend application along with its dependencies (PostgreSQL and Redis) using Docker Compose.

cd backend
docker-compose -f deployments/docker-compose.yml up -d

The backend server will be running on http://localhost:8080.

Option B: Local Development (Hot Reloading)

If you prefer developing locally on your host machine with hot-reloading:

1. Ensure your local PostgreSQL and Redis servers are running.
2. Update the .env file in the backend/ directory to point to your local Postgres and Redis instances.
3. Start the application using Air:

cd backend
make air

(Alternatively, you can just run make run or go run cmd/server/main.go)

API Documentation

Swagger API documentation is configured for the backend. Once the server is running, you will be able to find the generated specs at backend/docs/swagger. To regenerate the swagger docs after making changes, run:

cd backend
make swagger