Skip to content

Commit

Permalink
chore: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ray-D-Song committed Oct 12, 2024
1 parent c6eded3 commit 290a7a2
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@

Faker Server is a mock server based on Faker.js. It can be used to generate mock data for development and testing.

![Faker Server](https://raw.githubusercontent.com/ray-d-song/faker-server/main/docs/static/preview.png)

Online access: [https://faker-preview.jenrays.com/](https://faker-preview.jenrays.com/)
Read-only key: `1234`

Mock API list:
* [`GET /mock/user/list`](https://faker-preview.jenrays.com/mock/user/list)
* [`POST /mock/user`](https://faker-preview.jenrays.com/mock/user)

## Deploy

Currently supports npm command and Docker deployment.
Expand All @@ -19,7 +28,7 @@ MongoDB Atlas usage method can be found [here](https://github.com/ray-d-song/fak

```bash
# Install
npm install -g faker-server
npm install -g @ray-d-song/faker-server
# Start
faker-server
```
Expand Down
Binary file added docs/static/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion docs/zh_CN/README.zhCN.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
Faker Server 是一个基于 Faker.js 的 mock 服务器。
使用 MongoDB 作为数据存储,包含一个前端管理页面,可以方便地管理 mock 数据。

![Faker Server](https://raw.githubusercontent.com/ray-d-song/faker-server/main/docs/static/preview.png)

在线访问:[https://faker-preview.jenrays.com/](https://faker-preview.jenrays.com/)
只读密钥:`1234`

Mock 接口列表:
* [`GET /mock/user/list`](https://faker-preview.jenrays.com/mock/user/list)
* [`POST /mock/user`](https://faker-preview.jenrays.com/mock/user)

## 部署

当前支持 npm 命令和 Docker 部署。
Expand All @@ -14,7 +23,7 @@ MongoDB Atlas 的使用方法见 [这里](https://github.com/ray-d-song/faker-se

```bash
# 安装
npm install -g faker-server
npm install -g @ray-d-song/faker-server
# 启动
faker-server
```
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ray-d-song/faker-server",
"version": "0.1.0-beta.3",
"version": "0.1.0-beta.4",
"description": "Faker.js mock server with a web interface",
"bin": {
"faker-server": "dist/index.cjs"
Expand Down

0 comments on commit 290a7a2

Please sign in to comment.