(Português)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Kobana_Boletos

Kobana_Boletos is a Rails application performing CRUD using an external API without persisting data in the local database table. List, create, update, show details, and cancel a bank billet. The billets are created by integrating the Rails project with the Kobana API in Sandbox.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• BoletoSimples
• Bulma
• Capybara
• City-State
• Dalli
• Dotenv
• Stimulus
• Turbo Rails

Database

• Kobana API in Sandbox

Key Features

• ActiveModel::Model
• ActiveModel::Attributes
• I18n

(back to top)

🚀 Live Demo

• Heroku

(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:

Ruby

Setup

Clone this repository to your desired folder:

using HTTPS:

  git clone https://github.com/ElsonOtake/Kobana_Boletos.git
  cd Kobana_Boletos

using an SSH key:

  git clone git@github.com:ElsonOtake/Kobana_Boletos.git
  cd Kobana_Boletos

using GitHub CLI:

  git clone gh repo clone ElsonOtake/Kobana_Boletos
  cd Kobana_Boletos

Install

Fill in the environment variables

  BOLETOSIMPLES_API_TOKEN=BOLETOSIMPLES_API_TOKEN

Install this project with:

  bundle install
  npm install

Usage

To run the project, execute the following command:

  bin/dev

Open http://localhost:3000/ on your browser.

Run tests

To run tests, run the following command:

  rails test test/models
  rails test test/controllers
  rails test test/integration
  rails test test/system

(back to top)

👥 Author

👤 Elson Otake

• GitHub: elsonotake
• Twitter: @elsonotake
• LinkedIn: elsonotake

(back to top)

🔭 Future Features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Kobana
• Microverse
• W3Schools
• Stack Overflow

(back to top)

📝 License

This project is MIT licensed.

(back to top)

(English)

📗 Tabela de conteúdo

• 📖 Sobre o projeto
  • 🛠 Construído com
    • Tech Stack
    • Características principais
  • 🚀 Live Demo
• 💻 Primeiros Passos
  • Pré-requisitos
  • Configuração
  • Instalação
  • Utilização
  • Executar testes
• 👥 Autor
• 🔭 Recursos futuros
• 🤝 Contribuição
• ⭐️ Mostre seu apoio
• 🙏 Agradecimentos
• 📝 Licença

📖 Kobana_Boletos

Kobana_Boletos é uma aplicação Rails que executa CRUD usando uma API externa sem persistir dados na tabela do banco de dados local. É possível listar boletos, criar novos boletos, alterar boletos, apresentar dados de um boleto e cancelar um boleto aberto. Os boletos são criados realizando a integração do projeto Rails com a API da Kobana em Sandbox.

🛠 Construído com

Tech Stack

Cliente

• Ruby on Rails

Servidor

• BoletoSimples
• Bulma
• Capybara
• City-State
• Dalli
• Dotenv
• Stimulus
• Turbo Rails

Banco de dados

• API da Kobana em Sandbox

Características principais

• ActiveModel::Model
• ActiveModel::Attributes
• I18n

(voltar ao topo)

🚀 Live Demo

• Heroku

(voltar ao topo)

💻 Primeiros Passos

Para obter uma cópia local instalada e funcionando, siga estas etapas.

Pré-requisitos

Para executar este projeto você precisa de:

Ruby

Configuração

Clone este repositório na pasta desejada:

usando HTTPS:

  git clone https://github.com/ElsonOtake/Kobana_Boletos.git
  cd Kobana_Boletos

usando uma chave SSH:

  git clone git@github.com:ElsonOtake/Kobana_Boletos.git
  cd Kobana_Boletos

usando GitHub CLI:

  git clone gh repo clone ElsonOtake/Kobana_Boletos
  cd Kobana_Boletos

Instalação

Preencha as variáveis de ambiente

  BOLETOSIMPLES_API_TOKEN=BOLETOSIMPLES_API_TOKEN

Instale este projeto com:

  bundle install
  npm install

Utilização

Para executar o projeto, execute o seguinte comando:

  bin/dev

Abra http://localhost:3000/ no seu navegador.

Executar testes

Para executar testes, execute os seguintes comandos:

  rails test test/models
  rails test test/controllers
  rails test test/integration
  rails test test/system

(voltar ao topo)

👥 Autor

👤 Elson Otake

• GitHub: elsonotake
• Twitter: @elsonotake
• LinkedIn: elsonotake

(voltar ao topo)

🔭 Recursos futuros

(voltar ao topo)

🤝 Contribuição

Contribuições, problemas e solicitações de recursos são bem-vindos!

Sinta-se à vontade para verificar a página de problemas.

(voltar ao topo)

⭐️ Mostre seu apoio

Give a ⭐️ if you like this project!

(voltar ao topo)

🙏 Agradecimentos

Eu gostaria de agradecer:

• Kobana
• Microverse
• W3Schools
• Stack Overflow

(voltar ao topo)

📝 Licença

Este projeto é licenciado pelo MIT.

(voltar ao topo)