Trufos Developer Documentation

Welcome to the developer documentation for Trufos, the REST Utility, Free and Open Source. This documentation is intended for engineers working on the Trufos project.

Trufos is an Electron-based REST client designed to be easy to use, efficient, and extendable. It aims to provide a fast, user-friendly, and customizable experience for API testing and development.

Key Features

  • Offline Usage: No registration or login required.
  • Large Payload Handling: Smooth handling of large request and response objects.
  • Version Control Friendly: Storage of requests and collections in a way that facilitates easy collaboration via Git.
  • Script Injection: Custom handling of HTTP requests and responses (planned).
  • Authentication Support: Support for various authentication methods (planned).
  • Plugin Architecture: Extendable for additional features and integrations (planned).

This documentation is organized into several sections:

  • Getting Started: How to set up your development environment, build, and run the application.
  • Project Structure: An overview of the project’s directory and file layout.
  • Architecture: In-depth explanations of the application’s architecture, including the main and renderer processes, IPC, state management, and more.
  • Development: Guidelines and information for developers, covering coding style, testing, and dependencies.
  • UI Components: Information about the UI components used and developed within the project.
  • Services: Detailed descriptions of the core services that power Trufos.

Source Code

The primary repository for Trufos is hosted on GitHub: EXXETA/trufos