mirror of
https://github.com/Kong/insomnia
synced 2024-11-08 06:39:48 +00:00
ea6d3ed602
* Version bump * Update readme and version * Testing * Testing Again
35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
# Insomnia REST Client [![Build Status](https://travis-ci.com/getinsomnia/app.svg?branch=master)](https://travis-ci.com/getinsomnia/app) [![Build status](https://ci.appveyor.com/api/projects/status/7b5a82uxbidpnkoa/branch/master?svg=true)](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/).
|
|
|
|
![Insomnia REST Client Screenshot](https://insomnia.rest/images/docs/promo.png?bust=1)
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
# Install and use correct Node version
|
|
nvm install
|
|
|
|
# Install dependencies
|
|
npm install
|
|
```
|
|
|
|
## 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.
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
## Build to Folder
|
|
|
|
Build all assets into `./build/`
|
|
|
|
```bash
|
|
npm run build
|
|
```
|