██   ██████ ██████  ████  ██████ ██   ██ ██████ ██   ██ ██████ ██   ██ ██████          ██   ██████ ██████ 
 ████  ██  ██ ██  ██ ██  ██   ██   ███  ██   ██   ███ ███ ██     ███  ██   ██           ████  ██  ██   ██   
██  ██ ██████ ██████ ██  ██   ██   ██ █ ██   ██   ██ █ ██ ████   ██ █ ██   ██   ██████ ██  ██ ██████   ██   
██████ ██     ██     ██  ██   ██   ██  ███   ██   ██   ██ ██     ██  ███   ██          ██████ ██       ██   
██  ██ ██     ██      ████  ██████ ██   ██   ██   ██   ██ ██████ ██   ██   ██          ██  ██ ██     ██████ 

Built with the tools and technologies:

💧 Table of Contents

Table of Contents

• 💧 Table of Contents
• 🌊 Overview
• 💦 Features
• 🔵 Project Structure
  • 🔷 Project Index
• 💠 Getting Started
  • 🅿️ Prerequisites
  • 🌀 Installation
  • 🔹 Usage
  • ❄ ️ Testing
• 🧊 Roadmap
• ⚪ Contributing
• ⬜ License
• ✨ Acknowledgments

---

🌊 Overview

The Appointment API is a comprehensive REST API service built with Go and Gin framework, designed to manage appointments, users, and services in a multi-tenant environment. This system provides a robust backend for scheduling applications, supporting features like user authentication, appointment management, service categorization, and payment processing. It's built with scalability and security in mind, using modern Go practices and a clean architecture approach.

---

💦 Features

• 🔐 Multi-tenant Architecture: Support for multiple business entities with isolated data
• 👥 User Management: Complete user authentication and authorization system
• 📅 Appointment Scheduling: Flexible appointment booking and management
• 💼 Service Management: Categorization and management of services
• 💳 Payment Processing: Integrated payment handling system
• 📱 Device Management: Support for multiple devices and notifications
• ⚙️ Settings Management: Customizable system settings per tenant
• 📊 Reporting: Built-in reporting capabilities
• 🔄 CORS Support: Cross-Origin Resource Sharing enabled
• 📝 Logging: Comprehensive logging system
• 🔒 Security: JWT-based authentication and middleware protection

---

🔵 Project Structure

└── appointment-api/
    ├── README.md
    ├── admin-endpoints.md
    ├── adminedit.md
    ├── appointment-api
    ├── cmd
    │   └── server
    ├── config.env
    ├── endpoints.md
    ├── go.mod
    ├── go.sum
    ├── internal
    │   ├── api
    │   ├── config
    │   ├── middleware
    │   ├── models
    │   ├── repository
    │   └── services
    ├── migrations
    │   ├── 001_public_schema.sql
    │   └── 005_complete_tenant_schema.sql
    └── tests
        ├── README.md
        └── test_runner.go

🔷 Project Index

APPOINTMENT-API/

__root__

⦿ __root__

File Name	Summary
go.sum	Go module dependency checksums
appointment-api	Main executable binary file
go.mod	Go module definition and dependency management

cmd

⦿ cmd

server

⦿ cmd.server

File Name	Summary
main.go	Application entry point and server initialization

migrations

⦿ migrations

File Name	Summary
001_public_schema.sql	Initial database schema setup
005_complete_tenant_schema.sql	Multi-tenant schema implementation

internal

⦿ internal

api

⦿ internal.api

File Name	Summary
auth_handler.go	Authentication and authorization request handlers
handlers.go	Common API request handlers and utilities
admin_handler.go	Administrative endpoints and operations
public_handler.go	Public API endpoints and handlers

config

⦿ internal.config

File Name	Summary
config.go	Code>❯ REPLACE-ME

repository

⦿ internal.repository

File Name	Summary
payment_repository.go	Code>❯ REPLACE-ME
contact_repository.go	Code>❯ REPLACE-ME
device_repository.go	Code>❯ REPLACE-ME
user_repository.go	Code>❯ REPLACE-ME
repository.go	Code>❯ REPLACE-ME
category_repository.go	Code>❯ REPLACE-ME
settings_repository.go	Code>❯ REPLACE-ME
service_repository.go	Code>❯ REPLACE-ME
appointment_repository.go	Code>❯ REPLACE-ME
specialist_repository.go	Code>❯ REPLACE-ME

middleware

⦿ internal.middleware

File Name	Summary
auth.go	Authentication middleware for request validation
tenant.go	Multi-tenant request processing middleware
logging.go	Request logging and monitoring middleware
cors.go	Cross-Origin Resource Sharing configuration

services

⦿ internal.services

File Name	Summary
tenant_service.go	Code>❯ REPLACE-ME
contact_service.go	Code>❯ REPLACE-ME
category_service.go	Code>❯ REPLACE-ME
specialist_service.go	Code>❯ REPLACE-ME
payment_service.go	Code>❯ REPLACE-ME
device_service.go	Code>❯ REPLACE-ME
tenant_cache.go	Code>❯ REPLACE-ME
user_service.go	Code>❯ REPLACE-ME
service_service.go	Code>❯ REPLACE-ME
upload_service.go	Code>❯ REPLACE-ME
appointment_service.go	Code>❯ REPLACE-ME
services.go	Code>❯ REPLACE-ME
settings_service.go	Code>❯ REPLACE-ME
auth_service.go	Code>❯ REPLACE-ME

models

⦿ internal.models

File Name	Summary
settings.go	Code>❯ REPLACE-ME
payment.go	Code>❯ REPLACE-ME
device.go	Code>❯ REPLACE-ME
category.go	Code>❯ REPLACE-ME
user.go	Code>❯ REPLACE-ME
report.go	Code>❯ REPLACE-ME
contact.go	Code>❯ REPLACE-ME
tenant.go	Code>❯ REPLACE-ME
appointment.go	Code>❯ REPLACE-ME

---

💠 Getting Started

🅿️ Prerequisites

This project requires the following dependencies:

• Programming Language: Go
• Package Manager: Go modules

🌀 Installation

Build appointment-api from the source and intsall dependencies:

1. Clone the repository:

   ❯ git clone https://github.com/cevrimxe/appointment-api

2. Navigate to the project directory:

   ❯ cd appointment-api

3. Install the dependencies:

   ❯ go mod download

4. Build the project:

   ❯ go build ./cmd/server

🔹 Usage

1. Configure your environment: Create a config.env file in the root directory with your configuration settings. Here's an example:

   # Database Configuration
   DB_HOST=localhost
   DB_PORT=5432
   DB_USER=postgres
   DB_PASSWORD=your_password
   DB_NAME=appointment_db
   DB_SSLMODE=disable
   
   # Server Configuration
   SERVER_PORT=8080
   
   # JWT Configuration
   JWT_SECRET=your-secret-key
   
   # App Configuration
   APP_ENV=development
   APP_DEBUG=true
   
   # Cloudinary Configuration (Optional - for file uploads)
   CLOUDINARY_CLOUD_NAME=your_cloud_name
   CLOUDINARY_API_KEY=your_api_key
   CLOUDINARY_API_SECRET=your_api_secret

2. Start the server:

   ❯ ./appointment-api

   Or run directly with Go:

   ❯ go run ./cmd/server

3. Access the API: The API will be available at http://localhost:8080 by default (or the port specified in your config)

❄️ Testing

Appointment-api uses Go's built-in testing package with testify assertions for enhanced testing capabilities. Run the test suite with:

Using go modules:

go test ./...

---

🧊 Roadmap

• v1.0.0: Core API implementation with basic appointment and user management
• v1.1.0: Advanced scheduling features with recurring appointments
• v1.2.0: Enhanced reporting and analytics
• v1.3.0: Mobile app integration with push notifications
• v2.0.0: Real-time scheduling and instant notifications

---

⚪ Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the appointment-api project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/cevrimxe/appointment-api

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

⬜ License

Appointment-api is protected under the LICENSE License. For more details, refer to the LICENSE file.

---

✨ Acknowledgments

• Thanks to the Go community for excellent documentation and support
• Gin Web Framework for providing a robust foundation
• JWT-Go for secure authentication
• All contributors who have helped shape and improve this project
• Special thanks to the open source community for inspiration and shared knowledge

---