Code Monkey home page Code Monkey logo

ratevid's Introduction

Ratevid

Getting Started

Prerequisites

  • Docker
  • Docker-compose

Running the project

Use the following command to build and run the project:

docker-compose up --build
# This command will also automatically apply the migrations.
# In case you want to apply the migrations manually, here is the command you need:
alembic upgrade head

API Documentation

Once the application is running, you can view the API documentation at this URL, and by default it is: http://localhost:8000/api/docs

API Usage Examples

Here are some examples of how to use the API:

Update Currency Rates

This endpoint is used to update currency rates:

POST http://localhost:8000/api/updates
Content-Type: application/json

{}

Checking the Last Updated Currency Rates

You can use this endpoint to check when the currency rates were last updated:

GET http://localhost:8000/api/updates/last
Accept: application/json

Exchanging Currency

This endpoint allows you to exchange one type of currency for another:

POST http://localhost:8000/api/exchanges
Content-Type: application/json

{
    "from_currency": "EUR",
    "to_currency": "RUB",
    "amount": 1000
}

Please replace the "from_currency", "to_currency" and "amount" fields with your desired currency types and amount.

ratevid's People

Contributors

avidyakov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.