Currency API Dashboard

Name: Currency Api Dashboard
Author: ghostcompiler

A premium, high-performance developer currency exchange rate platform built on Laravel 13, React 19, and Redis.

🌐 Overview

ghostcompiler-api is a complete developer API and dashboard solution modeled after Open Exchange Rates. The application pulls and processes daily international currency values for over 150 countries, optimizes performance using high-speed Redis database caching, logs query analytics, and exports developer API credentials.

Key Features

Secure API Tokens: Full CRUD token lifecycle manager inside the developer panel. Custom base fallback currencies (defaults to INR system-wide).
Daily Sync Engine: Automated daily command retrieves live values and updates local metadata (currencies, countries, names, rates).
Redis Caching: Cached endpoint metrics reduce database queries and ensure sub-10ms response times.
Sleek Developer Landing Page: Beautiful dark mode interface complete with Framer Motion animations, live guest conversion widgets, and code sample highlights.
Scalar Reference Docs: Interactive API documentation served at /docs with Scalar's modern dark theme UI, complete with Bearer Try-it-out options.

🛠️ Technology Stack

Framework: Laravel 13.x (PHP 8.5)
Client: React 19.x (InertiaJS v3)
Styling: TailwindCSS v4 with Shadcn theme variables
Cache: Redis (via predis driver)
Database: PostgreSQL
Docs UI: Scalar UI via CDN + /public/openapi.json
Test Suite: Pest PHP

📂 API Reference Endpoints

All API endpoints are prefixed with /api/v1 and require your token provided inside the header: Authorization: Bearer <your_token>.

1. Authorize / Validate Token

Route: GET /api/v1/authorize
Description: Validates that a key is active and returns metadata.

2. Get Rates by Token Default Currency

Route: GET /api/v1
Description: Returns active exchange rates relative to the token's configured base currency (falls back to INR).

3. Get Rates by Custom Base

Route: GET /api/v1/{code}
Description: Returns active exchange rates relative to the {code} base currency.

4. Convert Currency

Route: POST /api/v1/{from}/{to}
Request Body: {"amount": 100}
Description: Converts a specific amount from {from} to {to}.

🚀 Getting Started

1. Requirements

Ensure you have PHP 8.5+, Composer, Node.js 18+, Redis, and PostgreSQL running on your machine.

2. Install Dependencies

composer install
npm install

3. Environment Setup

Copy .env.example to .env and configure your database and Redis connections:

DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=currency_db
DB_USERNAME=postgres
DB_PASSWORD=secret

REDIS_CLIENT=predis
REDIS_HOST=127.0.0.1
REDIS_PORT=6379

Tip

To sync live exchange rates, you must configure your Open Exchange Rates app credentials. You can register and generate an API access token by visiting Open Exchange Rates Signup & Key Generator.

4. Database Migrations

php artisan migrate

5. Generate Route Definitions

Ensure Wayfinder compiles route types:

npm run build

6. Run Sync Command

Sync currencies and rates from providers:

php artisan app:sync-currencies

7. Run Server

Start the concurrent servers (Laravel development server + Vite dev watcher):

npm run dev

🧪 Testing and Formatting

To verify the features remain stable, execute feature assertions:

php artisan test --compact

Format modified PHP files before committing:

vendor/bin/pint --dirty --format agent

⚙️ Repository Details

URL: git@github.com:ghostcompiler/currency-api-dashboard.git

Development Environment

Built using ServBay

Mac M4 Tested
macOS Apple Silicon
Powered by ServBay

import { Head, Link } from '@inertiajs/react'; import { ArrowLeft, Key } from 'lucide-react'; import React from 'react'; import { Button } from '@/components/ui/button'; import { Card, CardContent, CardDescription, CardHeader, CardTitle, } from '@/components/ui/card'; export default function LicensePage() { return ( <> <Head title="Developer License Agreement" /> <div className="flex min-h-screen flex-col items-center bg-background p-6 text-foreground md:p-12"> <div className="w-full max-w-4xl space-y-8"> {/* Navigation Back */} <div className="flex items-center justify-between border-b border-border pb-6"> <div className="flex items-center gap-2"> <span className="rounded-lg bg-primary/10 p-2 text-primary"> <Key className="h-6 w-6" /> </span> <div> <h1 className="text-3xl font-extrabold tracking-tight"> API License Agreement </h1> <p className="text-sm text-muted-foreground"> Effective Date: June 1, 2026 </p> </div> </div> <Button variant="ghost" asChild> <Link href="/" className="flex items-center gap-2 font-medium" > <ArrowLeft className="h-4 w-4" /> Back to Home </Link> </Button> </div> {/* Main Content */} <Card className="border border-border bg-card text-card-foreground shadow-xs"> <CardHeader> <CardTitle className="text-xl font-bold"> Developer API License </CardTitle> <CardDescription> Grant and constraints of using rates dataset and conversion methods. </CardDescription> </CardHeader> <CardContent className="space-y-6 text-sm leading-relaxed text-muted-foreground"> <section className="space-y-2"> <h3 className="text-base font-bold text-foreground"> 1. Grant of License </h3> <p> Subject to compliance with our usage metrics, we grant you a limited, non-exclusive, non-transferable, revocable license to request, download, and utilize exchange rates data in your software applications. </p> </section> <section className="space-y-2"> <h3 className="text-base font-bold text-foreground"> 2. Permitted Uses </h3> <p> You may integrate the rates in web platforms, internal systems, mobile applications, and testing environments. You are encouraged to cache the data locally to enhance load times and minimize overall server dependency. </p> </section> <section className="space-y-2"> <h3 className="text-base font-bold text-foreground"> 3. Restrictions </h3> <p>You shall not:</p> <ul className="list-disc space-y-1 pl-5"> <li> Sell, lease, or sub-license the raw database content as a standalone service. </li> <li> Use the currency system to facilitate illegal financial transactions or market manipulation. </li> <li> Reverse engineer the rate synchronization cron script or bypass security features. </li> </ul> </section> <section className="space-y-2"> <h3 className="text-base font-bold text-foreground"> 4. Attribution Requirement </h3> <p> For public-facing applications using this API, developers must include a clear attribution note visible on the conversion screen (e.g., "Exchange rates powered by our local System API"). </p> </section> <section className="space-y-2"> <h3 className="text-base font-bold text-foreground"> 5. Termination </h3> <p> We reserve the right to suspend or terminate developer keys immediately upon breach of restrictions or failure to adhere to the terms. </p> </section> </CardContent> </Card> <div className="border-t border-border/50 pt-4 text-center text-xs text-muted-foreground"> © 2026 Currency System Corp. All rights reserved. Registered developers must abide by general guidelines. </div> </div> </div> </> ); }

Currency Api Dashboard