postcat/wiki/README.en.md

99 lines
2.7 KiB
Markdown
Raw Normal View History

2022-04-19 14:28:31 +08:00
<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">
2022-08-05 14:15:00 +08:00
A extensible API tool,Easy & Open Source API Ecosystem
2022-04-19 14:28:31 +08:00
</div>
2022-10-13 17:18:12 +08:00
![](https://docs.eoapi.io/images/eoapi-demo-en.png)
2022-04-19 14:28:31 +08:00
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
2022-08-05 14:15:00 +08:00
- Read our [User Manual](https://docs.eoapi.io) for more features
- Read our [developer documentation](https://developer.eoapi.io) to develop extensions
2022-04-19 14:28:31 +08:00
# Featue
2022-04-20 16:33:43 +08:00
📃 API Documentation
- HTTP protocol
- Various formats of request body: FormData, XML, JSON, Raw
2022-04-19 14:28:31 +08:00
2022-04-20 16:33:43 +08:00
⚡ API Test
2022-05-25 18:32:14 +08:00
2022-04-19 14:28:31 +08:00
- Quickly test the API
- Test local API
2022-08-05 14:15:00 +08:00
🎭 Mock
- Mock document interface return value
2022-04-19 14:28:31 +08:00
🌐 Test environment management
📶 Available offline
🌱 Extension Marketplace
💻 Collaboration
2022-08-05 14:15:00 +08:00
- Collaboration via remote data sources
2022-04-19 14:28:31 +08:00
# Build and run
## Prerequisites
2022-05-25 18:32:14 +08:00
- Node.js >= 14.17.x
- yarn >= 1.22.x
2022-04-19 14:28:31 +08:00
## 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.
2022-05-25 18:32:14 +08:00
2022-04-19 14:28:31 +08:00
```
yarn install
yarn start
2022-04-19 14:28:31 +08:00
```
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
2022-04-19 14:28:31 +08:00
```
## Command
### Run
2022-05-25 18:32:14 +08:00
| 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 |
2022-04-19 14:28:31 +08:00
### Build
2022-05-25 18:32:14 +08:00
| Command | Description |
| ------------ | ------------------------------------------------- |
| `yarn build` | Packaging Electron applications for each platform |
2022-04-19 14:28:31 +08:00
### Running the tests
2022-05-25 18:32:14 +08:00
| Command | Description |
| ----------- | ------------------ |
| `yarn test` | Execute unit tests |
2022-04-19 14:28:31 +08:00
# 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!