Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 1.73 KB

README.md

File metadata and controls

78 lines (52 loc) · 1.73 KB
Raw

Mars Afterman

Export beautiful docs in Markdown and HTML from postman collection

  • 👻 No Backend
  • 🔧 No configuration
  • 🔥 Customize the output of your documentation (Include Dark mode)
  • 🎉 Only HTML, CSS and Javascript (Quasar Framework power)

Note: The tool covers the basic options of a collection, variables, description, headers, body, routes, as needs arise more things will be added.

Main view

Main view

Table of content

Rules

The collection must be exported in version 2.1 and the requests must be organized in folders.

postman collection demo image

After this there is nothing else! 😄

Get started

$ git clone https://github.com/itsalb3rt/afterman.git
$ cd afterman

Install the dependencies

$ npm install

Start the app in development mode (hot-code reloading, error reporting, etc.)

$ quasar dev

Build the app for production

$ quasar build

Docker

$ docker build -t afterman .
$ docker run -d --name afterman -p 8000:80 --rm afterman

We should now be able to access the application on http://localhost:8000

Tools

Made with the ❤️ and of course with these great tools