Skip to content

Commit

Permalink
fix bugs and add demo!
Browse files Browse the repository at this point in the history
  • Loading branch information
jozsefsallai committed Sep 18, 2019
1 parent a1770c1 commit b6b7fc0
Show file tree
Hide file tree
Showing 21 changed files with 586 additions and 43 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Like [Postman Documenter](https://www.getpostman.com/api-documentation-generator) but for [Insomnia](https://insomnia.rest)! With this tool you can generate beautiful API documentation pages using your Insomnia export file.

Demo coming soon :)
**Demo: https://jozsefsallai.github.io/insomnia-documenter**

## Requirements
* Node.js (8.x or higher is recommended)
Expand Down Expand Up @@ -35,6 +35,12 @@ Options:
-h, --help output usage information
```

## Updating the API

Updating the API is super simple! Since Insomnia Documenter is a plug-and-play web app, you can just replace your `insomnia.json` with your new exported JSON file. Just make sure it's called `insomnia.json`.

The same actually applies to the logo as well (`logo.png`).

## Contribution

The CLI tool is a commander applet, while the frontend itself is a Svelte app. This project is still in beta, which means it has bugs and can be improved here and there. Contribution is most welcome :)
Expand Down
12 changes: 12 additions & 0 deletions bin/demo.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
const express = require('express');
const path = require('path');

const app = express();

app.use('/insomnia-documenter', express.static(path.resolve(__dirname, '..', 'docs')));
app.get('/', function (req, res) {
return res.redirect('/insomnia-documenter');
});
app.listen(5000, function () {
console.log('App listening on http://localhost:5000');
});
8 changes: 8 additions & 0 deletions docs/bundle.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b6b7fc0

Please sign in to comment.