Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 4.38 KB

README.en.md

File metadata and controls

116 lines (78 loc) · 4.38 KB

Postcat API Client

Postcat API Client

English | 简体中文

License Version Downloads Chat

`🛠️ A Little Update, A Big Transformation: Postcat is Undergoing a Revamp! 🚀

Hey there, Postcat friends!

Just a quick shout-out to let you all know that our project is currently on an exciting journey of restructuring. It's not that Postcat is unattended; in fact, we're actively injecting new energy into it!

Things might seem a bit quiet for now, but rest assured, we're busy behind the scenes. We're committed to making Postcat cooler and more user-friendly - it just takes a bit of time to polish and perfect.

So, stay tuned! Soon, you'll be meeting a revamped and rejuvenated Postcat. Your support and patience mean the world to us!

Exciting updates are on the horizon, stay tuned!`

Postcat UI

Postcat is a powerful open source, cross-platform (Windows, Mac, Linux, Browsers...) API development and testing tool that supports REST, Websocket and other protocols (soon to support GraphQL, gRPC, TCP, UDP), helping you speed up the completion of API Development and testing work.

While ensuring that Postcat is light and flexible, we also designed a powerful plug-in system for Postcat, allowing you to use plug-ins with one click to enhance Postcat's functions.

Postcat Extensions

Therefore, Postcat is theoretically an API product with infinite possibilities. We also visually added a cape to Postcat's cat, representing its infinite possibilities.

Roadmap

  • 🚀 Multi-protocol support -- Implemented: HTTP REST, Websocket -- Coming soon: GraphQL, TCP, UDP, gRPC
  • 📕 API Documentation
  • ✨ API Design
  • ⚡ API Test
  • 🎭 Mock
  • 🙌 Collaboration
  • 🎈 Document Sharing
  • 🗺 Environment
  • 🧶 Global variables
  • 🧩 Custom theme style
  • 🌐 Multilingual support: Chinese, English

Learn more:Github Project

💪 Contributors 💪

Thank you for making good things happen!

Power by contrib.rocks.

Bug and Feature Request

If you'd like to contact us, please create a Github issue. Thank you!

Document

Postcat User Document

Build and run

Prerequisites

  • Node.js >= 14.17.x
  • yarn >= 1.22.x

Running the code

We use yarn as a package management tool for development and building, and it is highly recommended that you do the same, but if you want to use npm it's perfectly fine, it just might take a little more time to install dependencies.

yarn install
yarn start

If you want to improve Angular development efficiency, you can install the command-line Angular-cli officially provided by Angular to quickly generate templates such as components and services.

yarn add @angular/cli --global

Command

Run

Command Description
yarn start In development mode, running on browser and desktop at the same time
yarn serve:web only runs in the web
yarn electron:serve only runs in the desktop

Build

Command Description
yarn build Packaging Electron applications for each platform

Running the tests

Command Description
yarn test Execute unit tests