mirror of
https://gitee.com/eolink_admin/postcat.git
synced 2024-12-04 20:58:01 +08:00
4342a22dea
commit 332a6a17178b56b71203acfc1c201e94711d4d5d Author: 夜鹰 <17kungfuboy@gmail.com> Date: Fri May 27 16:24:44 2022 +0800 fix: docs commit 0dda360267e1afcc9e5be01681e104ef6483a757 Author: 夜鹰 <17kungfuboy@gmail.com> Date: Fri May 27 16:10:33 2022 +0800 feat: docs commit ca5955aeb9665b70bb0b94b468643fc6ee118a28 Author: 夜鹰 <17kungfuboy@gmail.com> Date: Fri May 27 16:02:51 2022 +0800 feat: ignore some lint rulus commit 9e72fecb8df2f751aa679d8ae6bbdd00150b6e58 Author: 夜鹰 <17kungfuboy@gmail.com> Date: Fri May 27 12:02:39 2022 +0800 feat: try vercle commit 88d2b0925b9b4f340f90ee926debf3b4e519c117 Author: 夜鹰 <17kungfuboy@gmail.com> Date: Thu May 26 18:34:08 2022 +0800 feat: ignore setting.component.ts commit 966d1e396b259c9c1fad061c4484e2b99308dcc5 Author: 夜鹰 <17kungfuboy@gmail.com> Date: Thu May 26 16:36:34 2022 +0800 fix: icon path for yarn commit 7108a1035c9524632c9a107d99d19e6c584e8a79 Author: buqiyuan <1743369777@qq.com> Date: Thu May 26 15:20:12 2022 +0800 fix: ts error commit cdd32585a472181fbbffd9cbb2ff05669c684bc7 Author: 夜鹰 <17kungfuboy@gmail.com> Date: Thu May 26 12:50:46 2022 +0800 feat: switch to yarn
98 lines
2.5 KiB
Markdown
98 lines
2.5 KiB
Markdown
<p align="center">
|
|
<a href="https://github.com/eolinker/eoapi">
|
|
<img width="200" src="./images/logo.png">
|
|
</a>
|
|
</p>
|
|
<h1 align="center">Eoapi</h1>
|
|
<div align="center">
|
|
A lightweight, extensible API tool
|
|
</div>
|
|
|
|
![](./images/preview_1.png)
|
|
|
|
English | [简体中文](README.md)
|
|
|
|
# Getting started
|
|
|
|
- Try the [live demo](https://demo.eoapi.io/)
|
|
|
|
- You can download it on [Releases](https://github.com/eolinker/eoapi/releases) available for macOS, Windows
|
|
|
|
- Read our [document](https://www.eoapi.io/) for more features
|
|
|
|
# Featue
|
|
|
|
📃 API Documentation
|
|
|
|
- HTTP protocol
|
|
- Various formats of request body: FormData, XML, JSON, Raw
|
|
|
|
⚡ API Test
|
|
|
|
- Quickly test the API
|
|
- Test local API
|
|
|
|
🌐 Test environment management
|
|
|
|
📶 Available offline
|
|
|
|
🌱 Extension Marketplace
|
|
|
|
# Preview Features
|
|
|
|
💻 Collaboration
|
|
|
|
🎭 Mock Servers
|
|
|
|
# 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 |
|
|
|
|
# License
|
|
|
|
This project is licensed under the Apache-2.0 License - see the [LICENSE.md](LICENSE) file for details
|
|
|
|
# Contact us
|
|
|
|
If you'd like to contact us, please create a [Github issue](https://github.com/eolinker/eoapi/issues). Thank you!
|