Skip to content

sangnt1552314/digimontex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DigimonTex

A terminal-based Digimon viewer application built with Go and the tview library. This project displays Digimon information from the Digimon Wikipedia universe, powered by the Digi-API.

About

DigimonTex is a learning project created to explore Go programming and the tview terminal UI library. It provides an interactive terminal interface to browse and view detailed information about various Digimon characters.

Features

  • Interactive Terminal UI: Clean, mouse-enabled interface built with tview
  • Digimon Browser: Browse through a paginated list of Digimon
  • Detailed Information: View comprehensive details including:
    • Digimon images and field symbols
    • Name, release date, levels, types, and attributes
    • Detailed descriptions in English
    • Skills and abilities
  • Navigation: Easy navigation with keyboard shortcuts and mouse support
  • Real-time Data: Fetches live data from the Digi-API

Technology Stack

  • Language: Go 1.24.2
  • UI Library: tview - Terminal UI library
  • Terminal: tcell - Terminal handling
  • API: Digi-API - Digimon data source

Installation

  1. Clone the repository:
git clone https://github.com/sangnt1552314/digimontex.git
cd digimontex
  1. Install dependencies:
go mod download
  1. Run the application:
go run cmd/main.go

Usage

  • Navigation: Use arrow keys to navigate through the interface
  • Browse Digimon: Use the left panel to browse through available Digimon
  • Pagination: Use << and >> buttons to navigate between pages
  • View Details: Click on any Digimon name to view detailed information
  • Exit: Press Ctrl+C or click the "Exit" button to quit

Project Structure

digimontex/
├── cmd/
│   └── main.go              # Application entry point
├── internal/
│   ├── app/
│   │   └── digimontex.go    # Main application logic and UI setup
│   ├── models/
│   │   └── digimon.go       # Data models for API responses
│   └── services/
│       ├── common.go        # Common utilities
│       └── digimon.go       # API service functions
├── assets/
│   └── no-image.png         # Fallback image for missing images
└── storage/
    └── logs/                # Application logs

API Reference

This project uses the Digi-API which provides:

  • Digimon list with pagination
  • Detailed Digimon information by name or ID
  • High-quality images and comprehensive data

Learning Goals

This project was created to:

  • Learn Go programming fundamentals
  • Explore terminal UI development with tview
  • Practice API integration and HTTP clients
  • Understand Go project structure and organization
  • Work with image handling and display in terminals

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Digi-API for providing the Digimon data
  • tview library for the excellent terminal UI framework
  • Digimon franchise for the amazing characters and universe# digimontex

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors