Skip to content

developerHub01/ApiBolt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,368 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ApiBolt Banner

ApiBolt

A powerful, modern REST API client for efficient API development.

Release Website License Issues Stars

ApiBolt is a feature-rich REST API client designed to streamline the workflow of developers. Built with Electron and React, it offers a seamless and intuitive desktop experience for testing, debugging, and interacting with APIs. Whether you are building new integrations or troubleshooting existing endpoints, ApiBolt provides a comprehensive suite of tools to enhance your productivity.

The application is currently in active development, with many more exciting features planned for the future.

✨ Features

ApiBolt comes packed with a wide range of features to supercharge your API development:

  • Full Request Customization: Craft complex API requests with support for various methods (GET, POST, PUT, DELETE, etc.), headers, and body types (JSON, form-data, x-www-form-urlencoded).
  • Organized Collections: Group your API requests into folders and collections for better organization and management.
  • Environment Variables: Manage different environments (e.g., development, staging, production) with ease, using environment-specific variables in your requests.
  • Detailed Response Viewer: Inspect API responses with a clear and organized viewer, including status codes, headers, and formatted JSON.
  • Request History: Keep track of all your past requests for easy access and re-execution.
  • Authentication Helpers: Simplified authentication with support for various methods like Bearer Token and Basic Auth.
  • Code Snippet Generation: Generate client-side code snippets for your requests in various languages and frameworks.
  • Customizable Themes: Personalize your workspace with a theme editor and a marketplace for community-created themes.
  • Keyboard Shortcuts: Boost your efficiency with a comprehensive set of keyboard shortcuts.
  • Local Password Protection: Secure your projects with an optional local password.
  • Cross-Platform: Available for Windows, macOS, and Linux.

🌐 Website

The official website for ApiBolt is available at apibolt.com. Here you can find more information about the application, download the latest version, and stay up-to-date with the latest news and announcements.

The source code for the website is available on GitHub: ApiBolt-web

🗺️ Roadmap

ApiBolt is under active development, and we have many exciting features planned for the future. Here's a glimpse of what's coming:

  • WebSocket and gRPC Support: Expanding beyond REST to support other popular API protocols.
  • Advanced Scripting: Adding pre-request and post-request scripting capabilities for more complex workflows.
  • Plugin Architecture: Introducing a plugin system to allow the community to extend the functionality of ApiBolt.
  • Team Collaboration: Features to allow teams to share collections and collaborate on API development.

Stay tuned for more updates as we continue to improve and expand the capabilities of ApiBolt.

🚀 Getting Started

Follow these instructions to get ApiBolt up and running on your local machine.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/developerHub01/ApiBolt.git
    cd ApiBolt
  2. Install dependencies:

    pnpm install

Running the Application

  • Development Mode:

    To run the app in development mode with hot-reloading:

    pnpm dev
  • Preview Mode:

    To preview the production build locally:

    pnpm start

🖥️ Building the Application

You can build the application for different operating systems using the following commands:

  • Build for your current OS:

    pnpm build
  • Build for a specific OS:

    pnpm build:win
    pnpm build:mac
    pnpm build:linux

🛠️ Tech Stack

ApiBolt is built with a modern and powerful tech stack to ensure a robust and scalable application:

  • Electron: The foundation of our desktop app, allowing us to build a cross-platform application with web technologies.
  • React: Powers the user interface, providing a reactive and component-based architecture for a dynamic user experience.
  • TypeScript: Brings static typing to JavaScript, enhancing code quality and developer productivity.
  • Redux Toolkit: Manages the application's state in a predictable and centralized way.
  • Tailwind CSS: A utility-first CSS framework that allows for rapid UI development and easy customization.
  • Shadcn UI: A collection of beautifully designed and accessible UI components that form the backbone of our design system.
  • Drizzle ORM: A modern TypeScript ORM used to interact with the local SQLite database, ensuring type safety and ease of use.
  • Vite: Provides a blazing-fast development server and build tool, significantly improving the development workflow.

🗂️ Database Schema

The database schema for ApiBolt is designed to be simple and efficient. You can view the Entity-Relationship Diagram (ERD) to understand the relationships between the different tables.

🤝 Contributing

Contributions are welcome! If you have ideas for new features, bug fixes, or improvements, feel free to open an issue or submit a pull request. Please read our contributing guidelines before getting started. (Note: A formal CONTRIBUTING.md file is yet to be created).

📜 License

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

🖼️ Preview

Splash Screen Local Password
Splash Screen Local Password
Projects Collections
Projects Collections
Request Interface History
Request Interface History
Environments Marketplace
Environments Marketplace
Theme Editor Settings
Theme Editor Settings

About

ApiBolt is a powerful, modern REST API client built for developers who need an efficient and user-friendly way to test, debug, and interact with APIs. Built with Electron and React, ApiBolt delivers a seamless desktop application experience with an intuitive and polished interface.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages