Skip to content

Commit 746ca13

Browse files
committed
Update document to have API document link
1 parent 67f25a5 commit 746ca13

File tree

2 files changed

+29
-12
lines changed

2 files changed

+29
-12
lines changed

GUIDE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ABC User Feedback Guide
1+
# ABC User Feedback Integration Guide
22

33
## Image Storage Integration
44

@@ -8,13 +8,13 @@ ABC User Feedback supports the integration of image storage solutions to handle
88

99
There are two methods for uploading images associated with feedback:
1010

11-
1. **Multipart Upload API**: This method requires setting up the [image configuration](#configuration). Once configured, you can use the multipart upload API to securely upload images directly to your storage service.
11+
1. **Multipart Upload API**: This method requires setting up the [image configuration](#S3-configuration). Once configured, you can use the multipart upload API to securely upload images directly to your storage service.
1212

1313
2. **Feedback Creation API with Image URLs**: Alternatively, users can submit feedback with image URLs. This method does not require the image configuration setup; however, the image URLs must come from the whitelisted domains.
1414

1515
**Note**: For detailed instructions on using these methods, please refer to the API documentation. You can see the documentation by accessing to `{API server host}/docs` or `{API server host}/docs/redoc`.
1616

17-
### Configuration
17+
### S3 Configuration
1818

1919
To enable image uploads directly to the server, you must configure the image storage settings. The service uses the following configuration parameters and you can set them in the setting menu.
2020

README.md

+26-9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ ABC User Feedback is a standalone web application that manages Voice of Customer
66

77
![sample image](./assets/main.png)
88

9+
## Table of Contents
10+
11+
- [Features](#Features)
12+
- [Getting Started](#Getting-Started)
13+
- [Configuration](#configuration)
14+
- [Integration](#Integration)
15+
- [Development](#Development)
16+
- [Contributing](#Contributing-Guidelines)
17+
- [License](#license)
18+
19+
920
## Features
1021

1122
ABC User Feedback provides the following features:
@@ -56,21 +67,31 @@ docker pull line/abc-user-feedback-web
5667
docker pull line/abc-user-feedback-api
5768
```
5869

59-
### Configuration
70+
## Configuration
6071

61-
**Frontend**
72+
### Frontend
6273

6374
:point_right: [Go to Frontend README](./apps/web/README.md)
6475

6576
You can configure the frontend for session password, maximum time span to query, etc.
6677

67-
**Backend**
78+
### Backend
6879

6980
:point_right: [Go to Backend README](./apps/api/README.md)
7081

7182
You can configure the backend for MySQL, SMTP for email verification, OpenSearch-powered improved search experience, etc.
7283

73-
## Setup Dev Environment using Command Line Tool without Dependencies
84+
## Integration
85+
86+
If you want to integrate ABC User Feedback with your service, you can use the following features:
87+
88+
1. RESTful Web API - [API document page](https://line.github.io/abc-user-feedback).
89+
1. Accept images from user - [S3 Integration](./GUIDE.md#image-storage-integration).
90+
1. Webhooks - [Webhook specification](./GUIDE.md#Webhook-Feature).
91+
92+
## Development
93+
94+
### Setup Dev Environment using Command Line Tool without Dependencies
7495

7596
ABC User Feedback supports a command line tool(`auf-cli`) that easily runs both the frontend and backend.
7697

@@ -84,7 +105,7 @@ npx auf-cli stop # stop app
84105

85106
Please refer to the following npm package site: https://www.npmjs.com/package/auf-cli
86107

87-
## Setup Dev Environment Manually (Local)
108+
### Setup Dev Environment Manually (Local)
88109

89110
ABC User Feedback is using a monorepo (powered by [TurboRepo](https://turbo.build/)) with multiple apps and packages.
90111

@@ -129,10 +150,6 @@ pnpm turbo run dev --filter=web
129150
pnpm turbo run dev --filter=api
130151
```
131152

132-
### ADMIN WEB GUIDE
133-
134-
For detailed information on using the admin web interface, please refer to our [Admin Web Guide](./GUIDE.md).
135-
136153
### Build Docker Image
137154

138155
For your code build, you can build docker image using docker-compose. Please refer to [remote caching](https://turbo.build/repo/docs/core-concepts/remote-caching) and [deploying with docker](https://turbo.build/repo/docs/handbook/deploying-with-docker) using `turborepo`.

0 commit comments

Comments
 (0)