README.md

Buda Spreads Api

📗 Table of Contents

• 📗 Table of Contents
• 📖 Buda Spreads Api
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • ⭐️ Show your support
  • ❓ FAQ
  • 📝 License

📖 Buda Spreads Api

Buda Spreads API. Powered by Ruby on Rails for a robust backend API, this app allows users to retrieve the spread of all markets active on the Buda.com exchange. Users can choose to retrieve all spreads or the spread for a selected market. It also allows users to set up a spread alert.

🛠 Built With

Tech Stack

List of technologies used for this project

BackEnd

• Ruby on Rails
• Rspec

Front-end/View

• Swagger

Key Features

• Calculate the Spread of the all markets in Buda Exchange in a single call
• Calculates the spread for any of the markets on Buda.com
• Include automated tests using Rspec
• to save a "alert" spread that we will check in the future using polling to see if the spread is greater or less than that threshold

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

you need to install ruby 3.2.2 using the prefer tool, example:

• rvm

• rbenv

• asdf-vm

• Browser (Google Chrome, Mozilla Firefox, Safari or any other browser)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/mrcbq/buda-spread-api.git

Install

Install this project with:

  cd buda-spread-api
  bundle install

Usage

To run the project, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec

(back to top)

👥 Authors

👤 Marco Baquero

• GitHub: @mrcbq
• Twitter: @mrcbq
• LinkedIn: mrcbq

(back to top)

🔭 Future Features

• Improve UI
• Add more functionalities

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project,please give it a ⭐️!

(back to top)

❓ FAQ

• Do I need to install any program before running this project?

  • Yes, you need to install Ruby
  
  

• Can I use this project for my own purposes?

  • Yes, you can.

(back to top)

📝 License

This project is MIT licensed.

(back to top)