insomnia/README.md

48 lines
1.7 KiB
Markdown
Raw Normal View History

# Insomnia REST Client
2016-03-22 05:05:37 +00:00
[![Insomnia REST Client](https://img.shields.io/badge/maintainer-Insomnia-purple.svg?colorB=6e60cc)](https://insomnia.rest)
[![Build status](https://ci.appveyor.com/api/projects/status/pj03skhct2p1sved/branch/master?svg=true)](https://ci.appveyor.com/project/gschier/insomnia/branch/master)
2017-05-04 15:35:06 +00:00
[![license](https://img.shields.io/github/license/getinsomnia/insomnia.svg)]()
2016-04-14 01:08:39 +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
![Insomnia REST Client Screenshot](https://insomnia.rest/images/docs/promo.png)
2016-04-14 01:08:39 +00:00
## 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).
2016-04-14 01:08:39 +00:00
## Contributing
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
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) &copy; [Insomnia](https://insomnia.rest)