Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/danifromecuador/vitawalletbackend

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.Stack: Rails, PostreSQL
https://github.com/danifromecuador/vitawalletbackend

coindesk-api faraday postgresql postman rubocop ruby ruby-on-rails

Last synced: 3 days ago
JSON representation

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.Stack: Rails, PostreSQL

Awesome Lists containing this project

README

        

# 📗 Tabla de Contenidos

- [📖 Sobre el Proyecto](#about-project)
- [🛠 Creada con](#built-with)
- [Tech Stack](#tech-stack)
- [Características claves](#key-features)
- [Recursos](#resources)
- [💻 Live Link](#live-link)
- [💻 Para Empezar](#getting-started)
- [Setup](#setup)
- [Uso](#usage)
- [👥 Autores](#authors)
- [🔭 Características Futuras](#future-features)
- [🤝 Contribución](#contributing)
- [⭐️ Apoya mi trabajo](#support)
- [🙏 Reconocimientos](#acknowledgements)
- [📝 Licencia](#license)

# 📖 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

DataBase

### 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

(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](https://www.theodinproject.com/guides/installations)

### Setup

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

```sh
cd my-folder
git clone [email protected]:danifromecuador/vitaWalletBackEnd.git
cd vitaWallerBackEnd
```

### Uso

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

```sh
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](http://127.0.0.1:3000/users
)

(back to top)

## 👥 Autores

👤 **Dani Morillo**

- GitHub: [danifromecuador](https://github.com/danifromecuador)
- LinkedIn: [danifromec](https://www.linkedin.com/in/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](https://github.com/danifromecuador/vitaWalletBackEnd/issues) de GitHub

(back to top)

## ⭐️ Apoya mi trabajo

Si le gustó este proyecto, deme una estrella en [mi repo de GitHub](https://github.com/danifromecuador/plannywise)

(back to top)

## 🙏 Agradecimientos

Me gustaría agradecer a [César Valencia](https://www.linkedin.com/in/cesar-valencia-aguilar/) por el apoyo técnico y moral en este proyecto

También me gustaría agrader a [Julieta Clara](https://www.linkedin.com/in/julieta-clara-26b207296/) 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](./LICENSE)

(back to top)