insomnia/README.md

43 lines
990 B
Markdown
Raw Normal View History

# Insomnia REST Client [![Build Status](https://travis-ci.com/getinsomnia/app.svg?branch=master)](https://travis-ci.com/getinsomnia/app)
2016-03-22 05:05:37 +00:00
2016-11-30 01:55:53 +00:00
A simple REST API client, build with [Electron](http://electron.atom.io/).
2016-04-14 01:08:39 +00:00
![Insomnia REST Client](https://insomnia.rest/images/docs/promo.png)
2016-04-23 04:06:31 +00:00
## Setup
2016-04-14 01:08:39 +00:00
```bash
# Install and use correct Node version
nvm install
# Install dependencies
npm install
2016-04-14 01:08:39 +00:00
```
## Run Development
When you run the development environment, it will start both a dev server and an Electron
instance. The dev server is part of Webpack and is used to control hot module replacement
of UI components. This means that, if you change a component file, you will not need to
refresh the app to see the change. It will inject the new component immediately.
2016-04-14 01:08:39 +00:00
```bash
npm run dev
2016-04-14 01:08:39 +00:00
```
## Build for Production
Build all assets into `./build/`
```bash
npm run build
```
## Build and Package Installers
Build binary files for each platform into `./dist/`
```bash
npm run package
```