Skip to content

Repository files navigation

Getman (API-Testing-Companion) 🚀

Getman is a powerful, lightweight, and intuitive desktop application designed to streamline your API testing and development workflow. Built for speed and reliability, it serves as a modern companion for testing RESTful services with ease.


✨ Features

  • Intuitive UI: A clean, distraction-free interface built with Tailwind CSS for a modern aesthetic.
  • Cross-Platform: Powered by Electron, ensuring a consistent experience across macOS, Windows, and Linux.
  • Fast & Lightweight: Built with Vite for instant hot-reloading and highly optimized performance during development.
  • Pre-configured Environment: Fully integrated with PostCSS and Tailwind for rapid UI customization.
  • Request Management: Seamlessly handle GET, POST, PUT, DELETE, and other standard HTTP methods.

🛠️ Tech Stack

Tool Purpose
Electron Desktop Framework
Vite Build Tool
Tailwind CSS Styling
JavaScript (Node.js) Language

🚀 Getting Started

Prerequisites

Ensure you have Node.js installed on your machine.

Installation

  1. Clone the repository:

    git clone https://github.com/TechGenDM/API-Testing-Companion.git
    cd API-Testing-Companion
  2. Install dependencies:

    npm install
  3. Run the application in development mode:

    npm start

Building for Production

To package the application for your specific operating system:

npm run make

📂 Project Structure

├── src/                      # Application source code (Main & Renderer)
├── dist/                     # Compiled production files
├── forge.config.js           # Electron Forge configuration
├── tailwind.config.js        # Tailwind CSS configuration
├── vite.main.config.mjs      # Vite configuration for Main process
├── vite.renderer.config.mjs  # Vite configuration for UI
└── index.html                # Main entry point for the UI

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

📄 License

Distributed under the MIT License. See LICENSE for more information.


Developed with ❤️ by Devasish Mishra

About

A lightweight, cross-platform desktop application for streamlining API testing and development workflows.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages