Code Monkey home page Code Monkey logo

postwoman's Introduction

When I wrote this, only God and I understood what I was doing. Now, only God knows.
Liyas Thomas

Liyas Thomas

Built with โค๏ธŽ by liyasthomas and contributors

Build Status GitHub release repo size license contributions welcome Website Donate Buy me a coffee

postwoman Postwoman

๐Ÿ‘ฝ API request builder by Liyas Thomas


postwoman postwoman

Features โœจ

โค๏ธ Lightweight: Crafted with minimalistic UI design

  • Faster, lighter, cleaner, minimal & responsive

โšก Real-time: Send requests and get/copy responses right away!

Methods:

  • GET - Retrieve information about the REST API resource
  • POST - Create a REST API resource
  • PUT - Update a REST API resource
  • DELETE - Delete a REST API resource or related component
  • OPTIONS - Describe the communication options for the target resource.

History entries are synced with local session storage

๐ŸŒˆ VIBGYOR: Neon combination background, foreground & accent colors - because customization === freedom โœจ

Customizations:

  • Dark and Light background themes
  • Choose accent color
  • Toggle multi-colored frames

Customized themes are also synced with local session storage

๐Ÿ”ฅ PWA: Install as a PWA on your device

Features:

  • Instant loading with Service Workers
  • Offline support
  • Low RAM/memory and CUP usage

๐Ÿ”Œ Web Socket: Establish full-duplex communication channels over a single TCP connection

  • Send and receive data

๐Ÿ” Authentication: Allows to identity the end user

Types:

  • None
  • Basic authentication using username and password
  • Token based authentication

๐Ÿ“ข Headers: Describes the format the body of your request is being sent as

๐Ÿ“ซ Parameters: Use request parameters to set varying parts in simulated requests

๐Ÿ“ƒ Request Body: Used to send and receive data via the REST API

Options:

  • Set content Type
  • Toggle between RAW input and parameter list

Demo

https://liyasthomas.github.io/postwoman

  1. Specify your request method
  2. Type in your API URL
  3. Add API path
  4. Send request
  5. Get response!

You're done!


Built with

  • Chromium - Thanks for being so fast!
  • HTML - For the web framework
  • CSS - For styling components
  • JavaScript - For magic!
  • Vue - To add to the JavaScript magic!
  • Nuxt - To add to the Vue magic!

Developing

  1. Clone this repo with git.
  2. Install dependencies by running npm install within the directory that you cloned (probably postwoman).
  3. Start the development server with npm run dev.
  4. Open development site by going to http://localhost:3000 in your browser.

Releasing

  1. Clone this repo with git.
  2. Install dependencies by running npm install within the directory that you cloned (probably postwoman).
  3. Build the release files with npm run build.
  4. Find the built project in ./dist.

Contributing

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.


Continuous Integration

We use Travis CI for continuous integration. Check out our Travis CI Status.


Versioning

This project is developed by Liyas Thomas using the Semantic Versioning specification. For the versions available, see the releases on this repository.


Change log

See the CHANGELOG file for details.


Authors

Lead Developers

Testing and Debugging

Contributors

Thanks

See the list of contributors who participated in this project.


License

This project is licensed under the MIT License - see the LICENSE file for details.


Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspirations:

postwoman's People

Contributors

abraham avatar andrewbastin avatar brandonhawi avatar chrispiccaro18 avatar edisonaugusthy avatar izerozlu avatar jacobanavisca avatar larouxn avatar liyasthomas avatar nbtx avatar nickpalenchar avatar nileshsp avatar reefqi037 avatar samjakob avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.