📗 Tabla de Contenidos

• 📖 Sobre el Proyecto
  • 🛠 Creada con
    • Tech Stack
    • Características claves
    • Recursos
• 💻 Live Link
• 💻 Para Empezar
  • Setup
  • Uso
• 👥 Autores
• 🔭 Características Futuras
• 🤝 Contribución
• ⭐️ Apoya mi trabajo
• 🙏 Reconocimientos
• 📝 Licencia

📖 VitaWallet API

VitaWallet API es una API Rest que permite realizar transacciones de compra o venta entre USD y BTC al precio actual del mercado, revisar la tasa de cambio del BTC/USD, consultar todas las transacciones de un usuario y consultar los detalles de una transacción.

Por favor, lea la documentación antes de usar la API.

🛠 Creada Con

Tech Stack

BackEnd

• Rails
• Postman

DataBase

• PostgreSQL

Características clave

• Un usuario se crea con un saldo inicial de BTC y/o USD
• Si tiene el saldo suficiente el usuario puede realizar transacciones
• El precio del bitcoin es obtenido mediante la API de CoinDesk
• Se especifica la moneda a enviar, la moneda a recibir y la cantidad a enviar, la cantidad a recibir se calcula automáticamente

Recursos

• CoinDesk API
• Gema Faraday

(back to top)

Live Link

vitawalletapi.onrender.com/v1/users

(back to top)

💻 Getting Started

Para obtener una copia local y ejecutar el proyecto, siga los siguientes pasos:

Prerrequisitos

Para ejecutar este proyecto localmente necesitará:

Instalar Git, Ruby, Rails y PostgreSQL, si usa Linux, siga este tutorial

Setup

Clonar el repositorio en el directorio de su elección:

  cd my-folder
  git clone git@github.com:danifromecuador/vitaWalletBackEnd.git
  cd vitaWallerBackEnd

Uso

Para correr este proyecto, ejecute los siguientes comandos, presione Enter luego de cada línea

  bundle install
  rails db:create
  rails s

Luego de eso el proyecto estará ejecutándose en el servidor local, abra el siguiente enlace en el navegador de su preferencia: http://127.0.0.1:3000/users

(back to top)

👥 Autores

👤 Dani Morillo

• GitHub: danifromecuador
• LinkedIn: danifromec

(back to top)

🔭 Características Futuras

• Se crearán los tests usando RSpec
• Se añadirán validaciones adicionales como cantidades máximas en User y Transaction
• Se creará un FrontEnd básico para consumir la API
• El precio del bitcoin se actualizará automáticamente y se mostrará en el FrontEnd
• Se autentificará la creación e inicio de sesión de los usuarios, con contraseña y correo de recuperación

(back to top)

🤝 Contribuciones

Si desea contribuir, reportar issues o cualquier sugerencia, puede hacerlo en la issues page de GitHub

(back to top)

⭐️ Apoya mi trabajo

Si le gustó este proyecto, deme una estrella en mi repo de GitHub

(back to top)

🙏 Agradecimientos

Me gustaría agradecer a César Valencia por el apoyo técnico y moral en este proyecto

También me gustaría agrader a Julieta Clara por la oportunidad de poner a prueba mis habilidades técnicas en back-end con esta prueba técnica

(back to top)

📝 Licencia

Este proyecto tiene licencia MIT

(back to top)