hoppscotch/README.md

142 lines
5.1 KiB
Markdown
Raw Normal View History

2019-08-21 13:18:20 +00:00
```
When I wrote this, only God and I understood what I was doing. Now, only God knows.
```
<div align="center">
<a href="https://liyas-thomas.firebaseapp.com"><img src="https://raw.githubusercontent.com/liyasthomas/templates/master/assets/logo.gif" alt="Liyas Thomas" width="200"></a>
<br>
<h1>Liyas Thomas</h1>
<sub>Built with ❤︎ by
<a href="https://github.com/liyasthomas">liyasthomas</a> and
<a href="https://github.com/liyasthomas/postwoman/graphs/contributors">contributors</a>
</sub>
2019-08-21 13:18:20 +00:00
</div>
---
[![Build Status](https://travis-ci.org/liyasthomas/postwoman.svg?branch=master)](https://travis-ci.org/liyasthomas/postwoman) [![GitHub release](https://img.shields.io/github/release/liyasthomas/postwoman/all.svg)](https://github.com/liyasthomas/postwoman/releases/latest) [![repo size](https://img.shields.io/github/repo-size/liyasthomas/postwoman.svg)](https://github.com/liyasthomas/postwoman/archive/master.zip) [![license](https://img.shields.io/github/license/liyasthomas/postwoman.svg)](https://github.com/liyasthomas/postwoman/blob/master/LICENSE) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/liyasthomas/postwoman/issues) [![Website](https://img.shields.io/website-up-down-green-red/https/shields.io.svg?label=website)](https://liyas-thomas.firebaseapp.com) [![Donate](https://img.shields.io/badge/$-donate-ff69b4.svg)](https://www.paypal.me/liyascthomas) [![Buy me a coffee](https://img.shields.io/badge/$-BuyMeACoffee-orange.svg)](https://www.buymeacoffee.com/liyasthomas)
2019-08-21 13:18:20 +00:00
# <img src="static/icon.png" alt="postwoman" width="32"> Postwoman
2019-08-21 13:18:20 +00:00
2019-08-22 06:20:26 +00:00
### 👽 API request builder by [Liyas Thomas](https://github.com/liyasthomas)
2019-08-21 13:18:20 +00:00
<div align="center">
<br>
<img src="static/screely.png" alt="postwoman" width="100%">
<img src="static/screely2.png" alt="postwoman" width="100%">
2019-08-21 13:18:20 +00:00
<br>
</div>
### Features :sparkles:
:heart: **Lightweight and minimal**: Crafted with minimalistic UI design
:electric_plug: **Real-time demo**: Send requests and get response right away!
2019-08-21 13:18:20 +00:00
2019-08-22 06:20:26 +00:00
:robot: **VIBGYOR**: Neon combination of colors for background and foreground
2019-08-21 13:18:20 +00:00
2019-08-22 06:20:26 +00:00
:sparkles: **PWA**: Install as a PWA on your device
2019-08-21 13:18:20 +00:00
---
## Demo
2019-08-22 06:20:26 +00:00
[https://liyasthomas.github.io/postwoman](https://liyasthomas.github.io/postwoman)
2019-08-21 13:18:20 +00:00
2019-08-22 06:20:26 +00:00
1. Specify your request method
2. Type in your API URL
3. Add API path
4. Send request
5. Get response!
2019-08-21 13:18:20 +00:00
You're done!
---
## Built with
* **[Chromium](https://github.com/chromium/chromium)** - Thanks for being so fast!
* HTML - For the web framework
* CSS - For styling components
* JavaScript - For magic!
* [Vue](https://vuejs.org/) - To add to the JavaScript magic!
* [Nuxt](https://nuxtjs.org/) - To add to the Vue magic! <!-- (Nuxt helps create the PWA and single page application.) -->
2019-08-21 13:18:20 +00:00
---
## Developing
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
1. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman`).
1. Start the development server with `npm run dev`.
1. Open development site by going to [http://localhost:3000](http://localhost:3000) in your browser.
---
## Releasing
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
1. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman`).
1. Build the release files with `npm run build`.
1. Find the built project in `./dist`.
---
2019-08-21 13:18:20 +00:00
## Contributing
Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our [CODE OF CONDUCT](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
---
## Continuous Integration
2019-08-22 06:20:26 +00:00
We use [Travis CI](https://travis-ci.com) for continuous integration. Check out our [Travis CI Status](https://travis-ci.org/liyasthomas/postwoman).
2019-08-21 13:18:20 +00:00
---
## Versioning
2019-08-22 06:20:26 +00:00
This project is developed by [Liyas Thomas](https://github.com/liyasthomas) using the [Semantic Versioning specification](https://semver.org). For the versions available, see the [releases on this repository](https://github.com/liyasthomas/postwoman/releases).
2019-08-21 13:18:20 +00:00
---
## Change log
See the [CHANGELOG](CHANGELOG.md) file for details.
---
## Authors
### Lead Developers
* [**Liyas Thomas**](https://github.com/liyasthomas) - *Author*
### Testing and Debugging
* [Liyas Thomas](https://github.com/liyasthomas)
### Contributors
2019-08-26 06:21:47 +00:00
* [NBTX](https://github.com/NBTX)
2019-08-23 04:04:48 +00:00
* [Andrew Bastin](https://github.com/AndrewBastin)
2019-08-26 06:21:47 +00:00
* [Nick Palenchar](https://github.com/nickpalenchar)
2019-08-23 04:04:48 +00:00
* [Abraham Williams](https://github.com/abraham)
2019-08-26 06:21:47 +00:00
* [Nicholas La Roux](https://github.com/larouxn)
* [RifqiAlAbqary](https://github.com/reefqi037)
* [izerozlu](https://github.com/izerozlu)
2019-08-21 13:18:20 +00:00
### Thanks
* [Dribbble](https://dribbble.com)
2019-08-22 06:20:26 +00:00
See the list of [contributors](https://github.com/liyasthomas/postwoman/graphs/contributors) who participated in this project.
2019-08-21 13:18:20 +00:00
---
## License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE](LICENSE) file for details.
---
## Acknowledgments
* Hat tip to anyone who's code was used
* Inspirations:
* [Dribbble](https://dribbble.com)