Giter Club home page Giter Club logo

go-btc-service's Introduction

go-btc-service

go-btc-service is a simple API service that allows you to retrieve the current exchange rate of Bitcoin (BTC) to Ukrainian Hryvnia (UAH), subscribe for rate change notifications, and send rate updates to subscribed email addresses. It is implemented using the Go programming language.

asciicast

Requirements

  • Go
  • Docker

Installation and Usage

  • Clone the repository
git clone https://github.com/i-stanko/go-btc-service.git
  • Navigate to the project directory
cd go-btc-service
  • Start the server
go run main.go data.go 

The server will be available at http://localhost:8080. Make requests to the API using an API client such as curl or Postman, or make requests from your own program.

API

  • Get Current BTC to UAH Exchange Rate. This endpoint returns the current exchange rate of Bitcoin to Ukrainian Hryvnia.
curl http://localhost:8080/api/rate
  • Subscribe Email for Rate Updates. This endpoint adds an email address to the subscription list for receiving rate updates.
curl -X POST \
    -d "[email protected]" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    http://localhost:8080/api/subscribe
  • Send Rate Updates to Subscribed Emails. This endpoint sends rate updates to all subscribed email addresses.
curl -X POST \
    -H "Content-Type: application/json" \
    http://localhost:8080/api/sendEmails

Docker

To deploy this service in a Docker container, follow these steps:

  • Build the Docker image
docker build -t go-btc-service .
  • Run the Docker container
docker run -p 8080:8080 go-btc-service

The server will be available at http://localhost:8080.

Additional Information

  • Data is stored and managed using the file system.
  • Swagger documentation is available at gses2swagger.yaml.
  • If you have any further questions or need assistance, please let me know.

go-btc-service's People

Contributors

i-stanko avatar

Watchers

 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.