Hermes-API

Welcome to Hermes-API, the backend powering a restaurant platform. This API enables restaurants, delivery personnel, and customers to interact seamlessly through a robust and scalable system.

Features

• 🍽️ Restaurant Management - Manage menus, orders, and operational details.
• 🚀 Order Processing - Handle real-time order tracking and fulfillment.
• 📦 Delivery System - Assign and track deliveries efficiently.
• 🔑 Authentication & Authorization - Secure access using JWT and OAuth.
• ⚡ Scalable Architecture - Built with Golang, PostgreSQL, Redis, and Docker.

Getting Started

Prerequisites

Ensure you have the following installed:

• Go (latest stable version recommended)
• Docker (for containerized deployment)
• PostgreSQL (if running the database locally)
• Redis (for caching and queue management)

Installation

1. Clone the repository:

   git clone https://github.com/your-username/hermes-api.git

2. Navigate to the project directory:

   cd hermes-api

3. Install dependencies:

   go mod tidy

Configuration

• Copy the .env.example file and rename it to .env:

  cp .env.example .env

• Update the .env file with your database credentials and API keys.

Running the Application

Using Docker

docker-compose up --build

Running Without Docker

go run main.go

Running Tests

Run tests to ensure everything is working correctly:

go test ./...

Contributing

We welcome contributions! Please check our Contributing Guide for details on how to contribute.

License

Hermes-API is licensed under the MIT License.

---

🚀 Built with love by the Hermes-API Team