Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.11 KB

README.md

File metadata and controls

67 lines (45 loc) · 1.11 KB

🚀 Yoma API

A modern .NET 9 API powering the Yoma platform.

✨ Features

  • RESTful API design
  • Secure authentication and authorization
  • Data persistence with PostgreSQL
  • Comprehensive business logic implementation
  • Swagger documentation

🛠️ Development Setup

Prerequisites

  • .NET 9 SDK
  • Docker
  • PostgreSQL instance (or use the provided Docker Compose setup)

Getting Started

  1. Install dependencies:

    dotnet restore
  2. Set up your development database:

    # From project root
    docker-compose up -d postgresql-yoma
  3. Run the API locally:

    dotnet run --project src/Yoma.Core.Api
  4. Access Swagger documentation:

    https://localhost:5001/swagger
    

🧪 Testing

Run the test suite:

dotnet test

🏗️ Building

dotnet build --configuration Release

📚 Documentation

For more details on architecture, design decisions, and component guidelines, please refer to our documentation.