Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsalb3rt/afterman
🌕 Create beutiful docs in markdown and HTML from postman collection
https://github.com/itsalb3rt/afterman
collection docker hacktoberfest javascript postman quasar-framework vue
Last synced: 3 months ago
JSON representation
🌕 Create beutiful docs in markdown and HTML from postman collection
- Host: GitHub
- URL: https://github.com/itsalb3rt/afterman
- Owner: itsalb3rt
- License: mit
- Created: 2020-04-26T23:05:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-09T01:35:49.000Z (6 months ago)
- Last Synced: 2024-08-02T00:25:44.685Z (6 months ago)
- Topics: collection, docker, hacktoberfest, javascript, postman, quasar-framework, vue
- Language: Vue
- Homepage: https://afterman.netlify.app
- Size: 1.75 MB
- Stars: 49
- Watchers: 2
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- quasar-awesome - github
README
#  Afterman
Export beautiful docs in **Markdown** and **HTML** from postman collection
- :ghost: No Backend
- :wrench: No configuration
- :fire: Customize the output of your documentation *(Include Dark mode)*
- :tada: 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
## Table of content
- [Rules](#Rules)
- [Get started](#get-started)
- [Docker](#docker)
- [Tools for build this Web App](#tools)
## Rules
The collection must be exported in version 2.1 and the requests must be organized in folders.
After this there is nothing else! :smile:
---
## Get started
```bash
$ git clone https://github.com/itsalb3rt/afterman.git
$ cd afterman
```
### Install the dependencies
```bash
$ npm install
```
#### Start the app in development mode (hot-code reloading, error reporting, etc.)
```bash
$ quasar dev
```
#### Build the app for production
```bash
$ quasar build
```
---
## Docker
```bash
$ docker build -t afterman .
```
```bash
$ docker run -d --name afterman -p 8000:80 --rm afterman
```
We should now be able to access the application on [http://localhost:8000](http://localhost:8000)
---
## Tools
Made with the :heart: and of course with these great tools
- [Quasar Framework](https://github.com/quasarframework/quasar)
- [QMarkdown extension](https://github.com/quasarframework/quasar-ui-qmarkdown)
- [UniqId](https://github.com/adamhalasz/uniqid)
- [Turndown](https://github.com/domchristie/turndown)