mirror of
https://github.com/Kong/insomnia
synced 2024-11-08 06:39:48 +00:00
70182df41d
* Test Travis * Attempt 2 * Touch * Fix globs * Attempt fix * Touch again * Fix deploy * Updated * New Tag * OSX code signing for Travis
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
# Insomnia REST Client
|
|
|
|
[](https://insomnia.rest)
|
|
[](https://ci.appveyor.com/project/gschier/insomnia/branch/master)
|
|
[]()
|
|
|
|
Insomnia is a cross-platform _REST client_, built on top of [Electron](http://electron.atom.io/).
|
|
|
|
|
|
|
|
## Bugs and Feature Requests
|
|
|
|
Have a bug or a feature request? Please 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).
|
|
|
|
## Contributing
|
|
|
|
Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions
|
|
for opening issues, coding standards, and notes on development.
|
|
|
|
More over, if your pull request contains JavaScript patches or features, you must
|
|
include relevant unit tests.
|
|
|
|
Editor preferences are available in the [editor config](.editorconfig) for easy use in
|
|
common text editors. Read more and download plugins at <http://editorconfig.org>.
|
|
|
|
## Developing
|
|
|
|
Development on Insomnia can be done on Windows, Mac, and Linux with few requirements and only
|
|
requires [NodeJS 7.4](https://nodejs.org) and [Git](https://git-scm.com/) to get started.
|
|
|
|
```bash
|
|
# Install dependencies and build addons for Electron
|
|
npm install
|
|
npm run rebuild
|
|
|
|
# Start app
|
|
npm run dev
|
|
|
|
# Run tests
|
|
npm test
|
|
```
|
|
|
|
## License
|
|
|
|
[GNU AGPLv3](LICENSE) © [Insomnia](https://insomnia.rest)
|