Mr Peanutbutter API

A RESTful API developed with Ruby on Rails, providing crypto services using the CoinGecko API. This project uses Docker for easier development and deployment.

---

Content

• Mr Peanutbutter API
  • Content
  • Description
  • Características
  • Technologies
  • Installation
    • Previous Requirements
    • Steps to Configure this Repo Locally

---

Description

Mr Peanutbutter API is a project developed with Ruby on Rails that offers endpoints to consult cryptocurrency prices and register transactions for buying/selling. This application uses Docker to create a more robust environment and to simplify development.

---

Características

• API RESTful: Built following the best practices of Ruby on Rails.
• Documentation: Uses Swagger to display API documentation.
• Tests: Integrated with RSpec to ensure code quality.

---

Technologies

• Backend: Ruby (3.2) and Ruby on Rails (7.2.2)
• Containers: Docker & Docker Compose
• Documentation: Swagger (rswag-api, rswag-ui, rswag-specs)
• Tests: RSpec
• Database: PostgreSQL

---

Installation

Previous Requirements

• Docker
• Docker Compose
• VS Code or any other IDE

Steps to Configure this Repo Locally

1. Clone the repository:

   git clone https://github.com/anderCM/mr_peanutbutter.git
   cd mr_peanutbutter
   

2. Set up your own .env file or use .env.example
3. Run:

   docker-compose build
   docker-compose up -d
   
   

4. Install necessary gems using one of these options:

• 4.1 From your local environment: docker-compose run api bundle install
• 4.2 By connecting to the container:

  docker-compose exec api bash
  bundle install
  

5. Create the DB using one of these options:

• 4.1 From your local environment: docker-compose run api rails db:create
• 4.2 By connecting to the container:

  docker-compose exec api bash
  rails db:create
  
  

6. Visit http://localhost:3000 or use any PORT you configured in .env file