2017-04-04 23:06:43 +00:00
|
|
|
|
# Insomnia REST Client
|
2016-03-22 05:05:37 +00:00
|
|
|
|
|
2017-05-11 20:34:17 +00:00
|
|
|
|
[](https://insomnia.rest)
|
|
|
|
|
|
[](https://travis-ci.org/getinsomnia/insomnia)
|
2017-05-11 20:30:53 +00:00
|
|
|
|
[](https://chat.insomnia.rest/)
|
2017-05-11 20:48:07 +00:00
|
|
|
|
[](https://twitter.com/getinsomnia)
|
2017-11-27 00:00:10 +00:00
|
|
|
|
[](https://github.com/getinsomnia/insomnia/master/LICENSE)
|
2016-04-14 01:08:39 +00:00
|
|
|
|
|
2017-04-04 23:06:43 +00:00
|
|
|
|
Insomnia is a cross-platform _REST client_, built on top of [Electron](http://electron.atom.io/).
|
2016-04-23 04:06:31 +00:00
|
|
|
|
|
2017-11-16 17:41:53 +00:00
|
|
|
|
|
2016-04-14 01:08:39 +00:00
|
|
|
|
|
2017-10-17 14:56:40 +00:00
|
|
|
|
## Download
|
2017-10-17 14:55:56 +00:00
|
|
|
|
|
|
|
|
|
|
Insomnia is available for Mac, Windows, and Linux and can be downloaded
|
2017-10-17 14:56:40 +00:00
|
|
|
|
from the website.
|
|
|
|
|
|
|
2017-10-17 14:57:39 +00:00
|
|
|
|
**[https://insomnia.rest/download](https://insomnia.rest/download/)**
|
2017-10-17 14:55:56 +00:00
|
|
|
|
|
2017-04-04 23:06:43 +00:00
|
|
|
|
## Bugs and Feature Requests
|
2016-04-23 04:01:28 +00:00
|
|
|
|
|
2017-05-12 17:45:55 +00:00
|
|
|
|
Have a bug or a feature request? First, read the
|
2017-04-04 23:06:43 +00:00
|
|
|
|
[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).
|
2016-04-14 01:08:39 +00:00
|
|
|
|
|
2017-05-12 17:45:55 +00:00
|
|
|
|
For more generic product questions and feedback, join the [Slack Team](https://chat.insomnia.rest) or email
|
|
|
|
|
|
[support@insomnia.rest](mailto:support@insomnia.rest)
|
|
|
|
|
|
|
2017-04-04 23:06:43 +00:00
|
|
|
|
## Contributing
|
2016-11-16 17:18:39 +00:00
|
|
|
|
|
2018-01-26 06:39:05 +00:00
|
|
|
|
Please read through our [contributing guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md). Included are directions
|
2017-04-04 23:06:43 +00:00
|
|
|
|
for opening issues, coding standards, and notes on development.
|
2016-04-14 01:08:39 +00:00
|
|
|
|
|
2017-04-04 23:06:43 +00:00
|
|
|
|
Editor preferences are available in the [editor config](.editorconfig) for easy use in
|
2017-05-12 17:45:55 +00:00
|
|
|
|
common text editors. Read more and download plugins at [editorconfig.org](http://editorconfig.org).
|
2016-11-16 17:18:39 +00:00
|
|
|
|
|
2017-04-12 23:43:19 +00:00
|
|
|
|
## Developing
|
|
|
|
|
|
|
2017-05-12 17:45:55 +00:00
|
|
|
|
Development on Insomnia can be done on Mac, Windows, or Linux as long as you have
|
2017-08-01 16:58:08 +00:00
|
|
|
|
[NodeJS 8](https://nodejs.org) and [Git](https://git-scm.com/).
|
2017-04-12 23:43:19 +00:00
|
|
|
|
|
2017-07-19 04:48:28 +00:00
|
|
|
|
<details>
|
|
|
|
|
|
<summary>Initial Dev Setup</summary>
|
|
|
|
|
|
|
2017-11-26 20:45:40 +00:00
|
|
|
|
This repository is structured as a monorepo and contains many Node.JS packages. Each package has
|
|
|
|
|
|
it's own set of command, but the most common commands are available from the
|
|
|
|
|
|
root `[package.json](package.json)` adn can be accessed using the `npm run ...` command. Here
|
|
|
|
|
|
are the only three commands you should need to start developing on the app.
|
2017-04-12 23:43:19 +00:00
|
|
|
|
|
2017-11-26 20:45:40 +00:00
|
|
|
|
```bash
|
|
|
|
|
|
# Install and Link Dependencies
|
|
|
|
|
|
npm run bootstrap
|
2017-04-12 23:43:19 +00:00
|
|
|
|
|
2017-11-26 20:45:40 +00:00
|
|
|
|
# Run Tests
|
2017-04-12 23:43:19 +00:00
|
|
|
|
npm test
|
2017-11-26 20:45:40 +00:00
|
|
|
|
|
|
|
|
|
|
# Start App with Live Reload
|
2017-11-26 21:40:56 +00:00
|
|
|
|
npm run app-start
|
2017-04-12 23:43:19 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
2017-07-19 04:48:28 +00:00
|
|
|
|
</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>
|
|
|
|
|
|
|
2017-11-07 10:57:18 +00:00
|
|
|
|
## Plugins
|
|
|
|
|
|
|
|
|
|
|
|
Here is a list of plugins available for installation via NPM.
|
|
|
|
|
|
|
2017-12-13 15:39:52 +00:00
|
|
|
|
- [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
|
2017-12-22 22:15:58 +00:00
|
|
|
|
- [OS Util](https://www.npmjs.com/package/insomnia-plugin-os) – Get OS information
|
2017-11-07 10:57:18 +00:00
|
|
|
|
- [JWT Decode](https://www.npmjs.com/package/insomnia-plugin-jwtdecode) – Decode header or payload of JWT tokens
|
|
|
|
|
|
- [XDebug](https://www.npmjs.com/package/insomna-plugin-xdebug) – Enable Xdebug debugging by adding an `XDEBUG_SESSION` cookie to the request.
|
2017-11-16 18:05:48 +00:00
|
|
|
|
- [Random Number](https://www.npmjs.com/package/insomnia-plugin-randomnumber) – Generate a random integer between a minimum and maximum
|
2017-11-07 10:57:18 +00:00
|
|
|
|
- [Random Credit Card](https://www.npmjs.com/package/insomnia-plugin-randomcreditcard) – Generate random credit card numbers
|
2018-01-11 11:49:09 +00:00
|
|
|
|
- [Random UK Sort Code](https://www.npmjs.com/package/insomnia-plugin-randomuksortcode) – Generate random UK bank sort codes
|
2017-11-07 10:57:18 +00:00
|
|
|
|
|
2017-11-03 19:05:24 +00:00
|
|
|
|
## Community Projects
|
|
|
|
|
|
|
2017-11-07 10:57:18 +00:00
|
|
|
|
[Swaggymnia](https://github.com/mlabouardy/swaggymnia) – Generate [Swagger](https://swagger.io/) documentation for your existing API in Insomnia.
|
|
|
|
|
|
|
2017-11-26 21:10:01 +00:00
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
|
|
[MIT](LICENSE) © [Insomnia](https://insomnia.rest)
|
