postboy-tui 1.0.0

package/README.md

@@ -0,0 +1,188 @@
+# Postboy
+
+A modern, terminal-based API testing and development tool with a clean TUI (Text User Interface). Postboy helps you design, test, and debug HTTP requests efficiently, all from your terminal.
+
+---
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Screenshots](#screenshots)
+- [Feature Details](#feature-details)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+---
+
+## Features
+
+- **Intuitive TUI**: Clean, keyboard-driven interface for rapid API testing.
+- **Request Composer**: Easily create and edit HTTP requests (GET, POST, PUT, DELETE, etc.).
+- **History Management**: Automatically saves and organizes your request history.
+- **Response Viewer**: Pretty-prints JSON, XML, and raw responses.
+- **Theming**: Switch between ten different themes.
+- **Mock Server**: Quickly spin up mock endpoints for local testing.
+- **Logging**: Detailed request/response logs for debugging.
+- **Keyboard Shortcuts**: Efficient navigation and actions.
+- **Configurable**: Customize settings to fit your workflow.
+
+---
+
+## Installation
+
+```bash
+# Using bun
+bun install
+
+# Or using npm
+npm install
+```
+
+---
+
+## Usage
+
+### Run in Development
+
+```bash
+# Start the TUI (Text User Interface)
+bun run src/index.ts ui
+
+# Or with npm
+npm start -- ui
+```
+
+### CLI Commands
+
+- **Launch TUI interface:**
+  ```bash
+  bun run src/index.ts ui
+  # or, if installed globally:
+  postboy ui
+  ```
+
+- **Send a test API request (interactive prompt):**
+  ```bash
+  bun run src/index.ts test
+  # or
+  postboy test
+  ```
+
+- **List available mock API endpoints:**
+  ```bash
+  bun run src/index.ts mock-list
+  # or
+  postboy mock-list
+  ```
+
+### Build and Install Globally (Optional)
+
+To use the `postboy` command anywhere:
+
+```bash
+bun run build
+bun add -g .
+# Now you can use:
+postboy ui
+postboy test
+postboy mock-list
+```
+
+---
+
+## Feature Details
+
+### 1. Intuitive TUI
+
+A clean, keyboard-driven interface designed for productivity. Navigate between panels, compose requests, and view responses without leaving your terminal.
+
+<img width="1111" height="649" alt="image" src="https://github.com/user-attachments/assets/de940869-4bfe-4349-a1bd-2259d46f2fde" />
+
+---
+
+### 2. Request Composer
+
+Create and edit HTTP requests with support for all major methods. Add headers, body, and query parameters with ease.
+
+<img width="643" height="428" alt="image" src="https://github.com/user-attachments/assets/304c5903-f3c1-4470-85d2-39eebb184c63" />
+
+
+---
+
+### 3. History Management
+
+Automatically saves every request you make. Browse, search, and re-run previous requests.
+
+
+<img width="427" height="440" alt="image" src="https://github.com/user-attachments/assets/cf055710-5701-490c-bfc6-a9afbbea223d" />
+
+
+---
+
+### 4. Response Viewer
+
+View responses in a pretty-printed format. Supports JSON, XML, and raw text. Syntax highlighting for easy reading.
+
+<img width="646" height="692" alt="image" src="https://github.com/user-attachments/assets/d5c60702-c71e-410c-bfbd-2643f78403f3" />
+
+
+---
+
+### 5. Theming
+
+Switch between light and dark themes to suit your preference.
+
+> _Screenshot: Theming_
+
+---
+
+### 6. Mock Server
+
+Spin up local mock endpoints for testing your API clients without needing a real backend.
+
+---
+
+### 7. Logging
+
+Detailed logs of all requests and responses, including headers, status codes, and timings.
+
+---
+
+### 8. Keyboard Shortcuts
+
+Navigate and perform actions quickly using intuitive keyboard shortcuts.
+
+---
+
+### 9. Configurable
+
+Customize settings such as themes, default headers, and more to fit your workflow.
+
+---
+
+## Contributing
+
+Contributions are welcome! Please open issues or submit pull requests for new features, bug fixes, or improvements.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/YourFeature`)
+3. Commit your changes (`git commit -m 'Add some feature'`)
+4. Push to the branch (`git push origin feature/YourFeature`)
+5. Open a pull request
+
+---
+
+## License
+
+[MIT](./LICENSE)
+
+---
+
+## Contact
+
+For support, questions, or feedback, please open an issue or contact the maintainer.
+
+---

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "postboy-tui",
+  "version": "1.0.0",
+  "main": "dist/cli",
+  "bin": {
+    "postboy-tui": "dist/cli"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "bun run src/index.ts",
+    "build": "bun build src/index.ts --outfile=dist/cli --compile",
+    "dev": "bun run --watch src/index.ts"
+  },
+  "module": "src/index.ts",
+  "type": "module",
+  "private": false,
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/inquirer": "^9.0.8"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@types/react": "^19.1.8",
+    "axios": "^1.11.0",
+    "chalk": "4.1.2",
+    "cli-highlight": "^2.1.11",
+    "commander": "^14.0.0",
+    "ink": "^6.0.1",
+    "ink-big-text": "^2.0.0",
+    "ink-gradient": "^3.0.0",
+    "ink-link": "^4.1.0",
+    "ink-select-input": "^6.2.0",
+    "ink-spinner": "^5.0.0",
+    "ink-text-input": "^6.0.0",
+    "inquirer": "8.2.5",
+    "react": "^19.1.0",
+    "react-devtools-core": "^6.1.5",
+    "yaml": "^2.8.0"
+  }
+}