Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.28 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.28 KB
Raw

Frankfurter

Build

Frankfurter is a free and open-source currency data API that tracks reference exchange rates published by the European Central Bank.

Check the website for a detailed walkthrough.

Deployment

Using Docker

The simplest way to run Frankfurter is with Docker:

docker run -d -p 8080:8080 \
  -e "DATABASE_URL=<postgres_url>" \
  --name frankfurter lineofflight/frankfurter

Using Docker Compose

For a complete setup including PostgreSQL:

  1. Copy the docker-compose.yml file
  2. Run:
docker compose up --wait

Contributing

Frankfurter is built with Ruby. To contribute:

  1. Fork.
  2. Install dependencies with bundle install.
  3. Run tests with bundle exec rake.
  4. Push your changes to a feature branch.
  5. Open a pull request.

Roadmap

  • Infrastructure

    • Migrate from PostgreSQL to SQLite for simpler deployment.
    • Add API versioning in URL path.

  • Data Sources

    • Add support for multiple data providers.
      • IMF
      • Other central banks

  • Features

    • Add GraphQL endpoint.
    • Deploy as a blockchain oracle.