a060562697
* removes (unused and unwanted) husky scripts
might as well, it's only taking up space for nothing in our node_modules
* adds `lerna run clean` to main clean script
we didn't have `clean` scripts in the packages before, but now that we do, it makes sense to.... hahah... _use them_.
Note that it's important that we run the package scripts first, because otherwise after the rimraf (which is now at the end) there's no `lerna` left to call.
* adds missing clean script to insomnia-components
although it looks like there are other changes at first glance, there shouldn't be any behavioral differences now except the fact that build will always generate SVGs (which, was an oversight/bug that it wasn't before). We need this to occur so that when we clean it removes the things that were built, and when we build it replaces those same things.
* adds a postclean script to insomnia-app like every other package
I'll be honest, I'm not entirely sure what the reason is for having `postclean` scripts in every package with (mostly) `rimraf dist` (i.e. instead of just including that in the main clean script at the end), but that's clearly the convention - so for now I'm just following it
* removes references to old build artifact location
well, except for the .gitignore. I guess I could remove it from the .gitignore, commit it, commit deleting it, which would clear it from everyone's projects... but I'll just leave it there for a bit in the .gitignore. hopefully people either start fresh or run `clean` from the root every once in a while, which will clean this up.
After a few weeks or months we can remove these two references (in the package.json.clean and .gitignore) altogether if we feel like it.
* removes unused reference in config to build artifact
I searched high and low for every place I could find that consumes this file and none of them seem to use this field anyway. And even if they did, it's wrong. In fact, it's been wrong for a while I'd guess because (relative to the root, if that's what it was intended to mean).
As far as I can tell this was added
|
||
|---|---|---|
| .github | ||
| packages | ||
| plugins | ||
| screenshots | ||
| scripts | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| DEVELOPMENT.md | ||
| jest-preset.js | ||
| lerna.json | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.base.json | ||
| tsconfig.eslint.json | ||
Insomnia REST Client
Insomnia is a cross-platform REST client, built on top of Electron.
Download
Insomnia is available for Mac, Windows, and Linux and can be downloaded from the website.
https://insomnia.rest/download
Bugs and Feature Requests
Have a bug or a feature request? First, read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
For more generic product questions and feedback, join the Slack Team or email support@insomnia.rest
Contributing
Please read through our contributing guidelines and code of conduct. Included are directions for opening issues, coding standards, and notes on development.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at editorconfig.org.
Developing
Development on Insomnia can be done on Mac, Windows, or Linux as long as you have
NodeJS and Git. See the .nvmrc file located in the project for the correct Node version.
Initial Dev Setup
This repository is structured as a monorepo and contains many Node.JS packages. Each package has
its own set of commands, but the most common commands are available from the
root package.json and can be accessed using the npm run ... command. Here
are the only three commands you should need to start developing on the app.
# Install and Link Dependencies
npm run bootstrap
# Run Tests
npm test
# Start App with Live Reload
npm run app-start
If you are on Linux, you may need to install the following supporting packages
# Update library
sudo apt-get update
# Install font configuration library & support
sudo apt-get install libfontconfig-dev
sudo apt-get install font-manager
# Build capability for required font-scanner package
sudo apt-get install build-essential
Also on Linux, if Electron is failing during the bootstrap process, run the following
# Clear Electron install conflicts
rm -rf ~/.cache/electron
If you are on Windows and have problems, you may need to install Windows Build Tools
Editor Requirements
You can use any editor you'd like, but make sure to have support/plugins for the following tools:
- ESLint – For catching syntax problems and common errors
- JSX Syntax – For React components
- Flow – For type annotations
Plugins
Search, discover, and install plugins from the Insomnia Plugin Hub!
Community Projects
- Insomnia Documenter – Generate beautiful API documentation pages using the documenter plugin or your Insomnia export file.
- GitHub API Spec Importer – A complete set of GitHub REST API route specifications that can be imported straight into Insomnia.
- Swaggymnia – Generate Swagger documentation for your existing API in Insomnia.