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
|
|
|
[![Insomnia](https://img.shields.io/badge/maintainer-Insomnia-purple.svg?colorB=6e60cc)](https://insomnia.rest)
|
|
|
|
[![Travis](https://api.travis-ci.org/getinsomnia/insomnia.svg)](https://travis-ci.org/getinsomnia/insomnia)
|
2017-05-11 20:41:37 +00:00
|
|
|
[![AppVeyor](https://img.shields.io/appveyor/ci/gschier/insomnia.svg)](https://ci.appveyor.com/project/gschier/insomnia)
|
2017-05-10 18:38:15 +00:00
|
|
|
[![license](https://img.shields.io/github/license/getinsomnia/insomnia.svg)](LICENSE)
|
2017-05-11 20:30:53 +00:00
|
|
|
[![Slack Channel](https://chat.insomnia.rest/badge.svg)](https://chat.insomnia.rest/)
|
2017-05-11 20:48:07 +00:00
|
|
|
[![Twitter Follow](https://img.shields.io/twitter/follow/getinsomnia.svg?style=social&label=%40GetInsomnia%20on%20Twitter&style=plastic)](https://twitter.com/getinsomnia)
|
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-04-04 23:06:43 +00:00
|
|
|
![Insomnia REST Client Screenshot](https://insomnia.rest/images/docs/promo.png)
|
2016-04-14 01:08:39 +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
|
|
|
|
2017-04-04 23:06:43 +00:00
|
|
|
Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions
|
|
|
|
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
|
|
|
|
[NodeJS 7.4](https://nodejs.org) and [Git](https://git-scm.com/).
|
2017-04-12 23:43:19 +00:00
|
|
|
|
|
|
|
```bash
|
2017-05-03 17:48:23 +00:00
|
|
|
# Install dependencies and build addons for Electron
|
2017-04-12 23:43:19 +00:00
|
|
|
npm install
|
2017-05-03 17:48:23 +00:00
|
|
|
npm run rebuild
|
2017-04-12 23:43:19 +00:00
|
|
|
|
|
|
|
# Start app
|
|
|
|
npm run dev
|
|
|
|
|
|
|
|
# Run tests
|
|
|
|
npm test
|
|
|
|
```
|
|
|
|
|
2017-04-04 23:06:43 +00:00
|
|
|
## License
|
2016-11-16 17:18:39 +00:00
|
|
|
|
2017-05-10 19:09:34 +00:00
|
|
|
[GNU GPLv3](LICENSE) © [Insomnia](https://insomnia.rest)
|