Skip to content

Repository files navigation

🚀 Cryptography API Gateway

Cryptography API Gateway Banner

A Modern Cryptocurrency REST API Gateway Built With Ktor

یک سرویس بک‌اند مدرن مبتنی بر Ktor که به عنوان یک Crypto API Gateway عمل می‌کند.

این پروژه امکان دریافت لیست ارزهای دیجیتال و مشاهده اطلاعات دقیق هر ارز را از طریق REST API فراهم می‌کند.

ساختار پروژه بر اساس Clean Architecture طراحی شده و با استفاده از Docker قابل استقرار است.


📸 Screenshots

Crypto List Crypto Detail
---

✨ Features | قابلیت‌ها

🇺🇸 Features

  • Cryptocurrency list API
  • Cryptocurrency detail API
  • RESTful API
  • Clean Architecture
  • Dependency Injection with Koin
  • Kotlin Coroutines
  • Ktor HTTP Client
  • Docker Containerization
  • Railway Deployment

🇮🇷 قابلیت‌ها

  • دریافت لیست ارزهای دیجیتال
  • نمایش اطلاعات دقیق هر ارز دیجیتال
  • پیاده‌سازی REST API
  • معماری Clean Architecture
  • مدیریت وابستگی‌ها با Koin
  • پردازش غیرهمزمان با Kotlin Coroutines
  • ارتباط با API خارجی با Ktor Client
  • استقرار با Docker و Railway

🛠 Tech Stack

Technology Usage
Kotlin Programming Language
Ktor Server Backend Framework
Ktor Client HTTP Communication
Koin Dependency Injection
Kotlin Coroutines Async Processing
Docker Containerization
Clean Architecture Project Architecture
HTML5 Dashboard
CSS3 Styling
JavaScript Frontend Interaction

🔥 Live API

Base URL:

وی پی ان میخواد!

لینک وب اپلیکیشین


🔌 API Endpoints

🪙 Get Cryptocurrency List

دریافت لیست ارزهای دیجیتال

GET

GET https://cryptography.up.railway.app/cryptoList

🔍 Get Cryptocurrency Details

دریافت اطلاعات کامل یک ارز دیجیتال

GET

GET https://cryptography.up.railway.app/btc

📊 API Overview

Method Endpoint Description
GET /cryptoList دریافت لیست ارزهای دیجیتال
GET /btc دریافت اطلاعات یک ارز دیجیتال

🏗 Architecture

این پروژه بر اساس Clean Architecture ساخته شده است.

              Presentation Layer

        Routes • API • Dashboard

                    │

                    ▼

                Domain Layer

      Models • UseCases • Repository

                    │

                    ▼

                 Data Layer

    Repository • Remote API • Ktor Client

📂 Project Structure

src
│
├── data
│   ├── remote
│   ├── repository
│   └── model
│
├── domain
│   ├── model
│   ├── repository
│   └── usecase
│
├── presentation
│   ├── routes
│   └── dashboard
│
└── di

🐳 Docker

Build Image:

docker build -t cryptography-api-gateway .

Run Container:

docker run -p 8080:8080 cryptography-api-gateway

Server:

http://localhost:8080

🚂 Deployment

The project is deployed using:

Docker + Railway

Live Server:

https://cryptography.up.railway.app

🎯 Project Goals

  • Building a scalable backend service with Ktor
  • Applying Clean Architecture principles
  • Creating a reusable Crypto API Gateway
  • Learning backend development with Kotlin
  • Preparing production-ready API structure

❤️ Built With

Kotlin • Ktor • Koin • Docker • Clean Architecture

About

crypto list api build with KTOR

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages