{"id":24097323,"url":"https://github.com/0xataru/dfox","last_synced_at":"2025-05-07T15:42:55.753Z","repository":{"id":256041980,"uuid":"854098898","full_name":"0xataru/dfox","owner":"0xataru","description":"DFox is a Rust-based database management tool that provides a terminal user interface (TUI) for interacting with PostgreSQL and MySQL databases. It allows users to perform database operations easily and efficiently through a simple and intuitive interface.","archived":false,"fork":false,"pushed_at":"2024-11-24T11:22:31.000Z","size":804,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T11:35:24.818Z","etag":null,"topics":["crossterm","ratatui-rs","rust","sql","tui-rs"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0xataru.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-08T12:13:14.000Z","updated_at":"2025-02-06T22:16:40.000Z","dependencies_parsed_at":"2024-09-08T18:13:34.067Z","dependency_job_id":"6e572105-3114-4219-9a0b-344fc05db145","html_url":"https://github.com/0xataru/dfox","commit_stats":null,"previous_names":["markraiter/dfox","ataru993/dfox","0xataru/dfox"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xataru%2Fdfox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xataru%2Fdfox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xataru%2Fdfox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xataru%2Fdfox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xataru","download_url":"https://codeload.github.com/0xataru/dfox/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252908035,"owners_count":21823326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crossterm","ratatui-rs","rust","sql","tui-rs"],"created_at":"2025-01-10T13:26:57.333Z","updated_at":"2025-05-07T15:42:55.708Z","avatar_url":"https://github.com/0xataru.png","language":"Rust","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"examples/mini_logo.png\" alt=\"Centered Image\" width=\"300\"\u003e\n\u003c/p\u003e\n\n# DFox - ⚡️ Blazing Fast Terminal Database Manager\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) \n![GitHub top language](https://img.shields.io/github/languages/top/ataru993/dfox)\n\n**DFox** is a Rust-based database management tool that provides a terminal user interface (TUI) for interacting with PostgreSQL and MySQL databases.\nIt allows users to perform database operations easily and efficiently through a simple and intuitive interface.\n\n## Features\n\n- Connect to multiple database types: PostgreSQL, MySQL, (SQLite still in development).\n- User-friendly terminal interface for managing database connections and performing CRUD operations.\n- Dynamic rendering of database schemas and table data.\n- Easily extendable for additional database types and features.\n\n## Project Structure\n\nThe project is organized as a Cargo workspace consisting of two main components:\n\n- **dfox-core**: The core library responsible for database operations. It includes implementations for MySQL, PostgreSQL, and SQLite clients, as well as data models and error handling.\n- **dfox-tui**: The command-line interface for user interaction. It contains the main functions for launching the application, along with UI components and event handlers.\n\n## How It Works\n\n1. **Database Type Selection**  \n   Upon starting the application, the user is presented with a menu to select the database type (PostgreSQL, MySQL, or SQLite). Use the up/down keys to navigate and Enter to confirm your choice.  \n   ![Database Type Selection](./examples/db_type_selection.jpg)\n\n2. **Connection Input Screen**  \n   After selecting the database type, the user is prompted to input the connection details such as hostname, port, username, and password.  \n   ![Connection Input Screen](./examples/input_screen.jpg)\n\n3. **Database Selection**  \n   Once connected, a list of available databases is displayed. The user can choose the database to interact with.  \n   ![Database Selection](./examples/db_selection.jpg)\n\n4. **Table View**  \n   The application dynamically renders the list of tables available in the selected database.  \n   ![Table View](./examples/table_view.jpg)\n\n5. **Describe Table**  \n   The user can select a table to view its schema, displayed in a tree-like structure, including column names, types, and constraints.  \n   ![Describe Table](./examples/describe_table.jpg)\n\n6. **Query Execution and Results**  \n   The user can execute SQL queries and view the results in the TUI.  \n   ![Query Result](./examples/query_result.jpg)\n\n7. **Error Handling**  \n   If there is an error with the query or database operation, an error message is displayed in the interface.  \n   ![Query Error](./examples/query_error.jpg)\n\n\n## Installation\n\nTo build and run the project, ensure you have [Rust](https://www.rust-lang.org/) installed. Clone the repository and use Cargo to build the project:\n\n```bash\ngit clone https://github.com/markraiter/dfox.git\ncd dfox\ncargo build\n```\n\n## Usage\n\nAfter building the project, you can run the TUI application with the following command:\n\n```bash\ncargo run --bin dfox-tui\n```\n\n## Contributing\n\nContributions are welcome! If you would like to contribute to DFox, please follow these steps:\n\n1. Fork the repository.\n2. Create your feature branch (git checkout -b feature/my-feature).\n3. Commit your changes (git commit -m 'Add some feature').\n4. Push to the branch (git push origin feature/my-feature).\n5. Open a pull request.\n\n ## Acknowledgments\n\nThanks to the [Ukrainian Rust Community](https://github.com/rust-lang-ua) for their incredible support and resources.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xataru%2Fdfox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xataru%2Fdfox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xataru%2Fdfox/lists"}