Insomnia

The open-source, cross-platform API client for GraphQL, REST, WebSockets an...

HTTP client • Fetch • AJAXDesktop app
Kong/insomniainsomnia.rest

README

Insomnia API Client


Insomnia is an open-source, cross-platform API client for GraphQL, REST, WebSockets, Server-sent events and gRPC.

Insomnia API Client

Download


Insomnia is available for Mac, Windows, and Linux and can be downloaded
from the website.

https://insomnia.rest/download

Bugs and Feature Requests


Have a bug or a feature request? First, read the
issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

For more generic product questions and feedback, join the Slack Team.

Contributing


Please read through our contributing guidelines and code of conduct. Included are directions for opening issues, coding standards, and notes on development.

Documentation


Check out our open-source Insomnia Documentation.

Develop Insomnia


Development on Insomnia can be done on Mac, Windows, or Linux as long as you have Node.js and Git. See the.nvmrc file located in the project for the correct Node version.

Initial Dev Setup

This repository is structured as a monorepo and contains many Node.JS packages. Each package has its own set of commands, but the most common commands are available from the root [package.json](package.json) and can be accessed using the npm run … command. Here are the only three commands you should need to start developing on the app.

  1. ```shell
  2. # Install and Link Dependencies
  3. npm i

  5. # Run Lint
  6. npm run lint

  8. # Run type checking
  9. npm run type-check

  11. # Run Tests
  12. npm test

  14. # Start App with Live Reload
  15. npm run dev
  16. ```

Linux


If you are on Linux, you may need to install the following supporting packages:

Ubuntu/Debian

  1. ```shell
  2. # Update library
  3. sudo apt-get update

  5. # Install font configuration library & support
  6. sudo apt-get install libfontconfig-dev
  7. ```


Fedora

  1. ```shell
  2. # Install libcurl for node-libcurl
  3. sudo dnf install libcurl-devel
  4. ```


Also on Linux, if Electron is failing during the install process, run the following

  1. ```shell
  2. # Clear Electron install conflicts
  3. rm -rf ~/.cache/electron
  4. ```

Windows


If you are on Windows and have problems, you may need to install Windows Build Tools


Editor Requirements

You can use any editor you'd like, but make sure to have support/plugins for the following tools:

- ESLint - For catching syntax problems and common errors
- JSX Syntax - For React components


Develop Inso CLI


- npm i
- Start the compiler in watch mode: npm run inso-start
- Run: ./packages/insomnia-inso/bin/inso -v

Plugins


Search for, discover, and install plugins from the Insomnia Plugin Hub!