mirror of
https://github.com/Kong/insomnia
synced 2024-11-08 06:39:48 +00:00
114 lines
5.6 KiB
Markdown
114 lines
5.6 KiB
Markdown
# Insomnia REST Client
|
||
|
||
[](https://travis-ci.org/Kong/insomnia)
|
||
[](https://chat.insomnia.rest/)
|
||
[](https://github.com/Kong/insomnia/blob/master/LICENSE)
|
||
[](https://codefund.io)
|
||
|
||
Insomnia is a cross-platform _REST client_, built on top of [Electron](http://electron.atom.io/).
|
||
|
||
|
||
|
||
## Download
|
||
|
||
Insomnia is available for Mac, Windows, and Linux and can be downloaded
|
||
from the website.
|
||
|
||
**[https://insomnia.rest/download](https://insomnia.rest/download/)**
|
||
|
||
## Bugs and Feature Requests
|
||
|
||
Have a bug or a feature request? First, read the
|
||
[issue guidelines](CONTRIBUTING.md#using-the-issue-tracker) and search for existing and
|
||
closed issues. If your problem or idea is not addressed yet, [please open a new issue](/issues).
|
||
|
||
For more generic product questions and feedback, join the [Slack Team](https://chat.insomnia.rest) or email
|
||
[support@insomnia.rest](mailto:support@insomnia.rest)
|
||
|
||
## Contributing
|
||
|
||
Please read through our [contributing guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md). Included are directions
|
||
for opening issues, coding standards, and notes on development.
|
||
|
||
Editor preferences are available in the [editor config](.editorconfig) for easy use in
|
||
common text editors. Read more and download plugins at [editorconfig.org](http://editorconfig.org).
|
||
|
||
## Developing
|
||
|
||
Development on Insomnia can be done on Mac, Windows, or Linux as long as you have
|
||
[NodeJS 8](https://nodejs.org) and [Git](https://git-scm.com/).
|
||
|
||
<details>
|
||
<summary>Initial Dev Setup</summary>
|
||
|
||
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.
|
||
|
||
```bash
|
||
# Install and Link Dependencies
|
||
npm run bootstrap
|
||
|
||
# Run Tests
|
||
npm test
|
||
|
||
# Start App with Live Reload
|
||
npm run app-start
|
||
```
|
||
|
||
If you are on Linux and have problems, you may need to install `libfontconfig-dev`
|
||
|
||
```bash
|
||
# Install libfontconfig-dev
|
||
sudo apt-get install libfontconfig-dev
|
||
```
|
||
|
||
If you are on Windows and have problems, you may need to install [Windows Build Tools](https://github.com/felixrieseberg/windows-build-tools)
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Editor Requirements</summary>
|
||
|
||
You can use any editor you'd like, but make sure to have support/plugins for
|
||
the following tools:
|
||
|
||
- [ESLint](http://eslint.org/) – For catching syntax problems and common errors
|
||
- [JSX Syntax](https://facebook.github.io/react/docs/jsx-in-depth.html) – For React components
|
||
- [Flow](https://flow.org/) – For type annotations
|
||
|
||
</details>
|
||
|
||
## Plugins
|
||
|
||
Here is a list of plugins available for installation via NPM.
|
||
|
||
- [AWS IAM](https://www.npmjs.com/package/insomnia-plugin-aws-iam) – Template tag to retrieve system AWS credentials
|
||
- [Chance](https://www.npmjs.com/package/insomnia-plugin-chance) – Generates a random value using Chance.JS
|
||
- [Cuid](https://www.npmjs.com/package/insomnia-plugin-cuid) – Generate random cuids
|
||
- [Custom Timestamp](https://www.npmjs.com/package/insomnia-plugin-customtimestamp) – Advanced timestamp creator
|
||
- [Default Headers](https://www.npmjs.com/package/insomnia-plugin-default-headers) – Set default headers on requests
|
||
- [Defaults](https://www.npmjs.com/package/insomnia-plugin-defaults) - Set request defaults through your environment
|
||
- [Faker](https://www.npmjs.com/package/insomnia-plugin-faker) - Generate Faker data right within Insomnia!
|
||
- [Github Apps](https://www.npmjs.com/package/insomnia-plugin-github-apps-helper) – Generates a JWT for auth with the GitHub API as your GitHub App
|
||
- [Javascript Eval](https://www.npmjs.com/package/insomnia-plugin-js-eval) - Evaluate/run Javascript code
|
||
- [JWT Decode](https://www.npmjs.com/package/insomnia-plugin-jwtdecode) – Decode header or payload of JWT tokens
|
||
- [OS Util](https://www.npmjs.com/package/insomnia-plugin-os) – Get OS information
|
||
- [Random Credit Card](https://www.npmjs.com/package/insomnia-plugin-randomcreditcard) – Generate random credit card numbers
|
||
- [Random Number](https://www.npmjs.com/package/insomnia-plugin-randomnumber) – Generate a random integer between a minimum and maximum
|
||
- [Random UK Sort Code](https://www.npmjs.com/package/insomnia-plugin-randomuksortcode) – Generate random UK bank sort codes
|
||
- [Regex](https://www.npmjs.com/package/insomnia-plugin-regex) – Extract a value from an environment variable using a regular expression
|
||
- [Swagger Validator](https://www.npmjs.com/package/insomnia-plugin-validator) – Validate an API response to a swagger spec
|
||
- [XDebug](https://www.npmjs.com/package/insomnia-plugin-xdebug) – Enable Xdebug debugging by adding an `XDEBUG_SESSION` cookie to the request
|
||
|
||
## Community Projects
|
||
|
||
- [Insomnia Documenter](https://github.com/jozsefsallai/insomnia-documenter) – Generate beautiful API documentation pages using your Insomnia export file.
|
||
- [GitHub API Spec Importer](https://github.com/swinton/github-rest-apis-for-insomnia) – A complete set of GitHub REST API route specifications that can be imported straight into Insomnia
|
||
- [Swaggymnia](https://github.com/mlabouardy/swaggymnia) – Generate [Swagger](https://swagger.io/) documentation for your existing API in Insomnia.
|
||
|
||
## License
|
||
|
||
[MIT](LICENSE) © [Insomnia](https://insomnia.rest)
|