You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: GUIDE.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# ABC User Feedback Guide
1
+
# ABC User Feedback Integration Guide
2
2
3
3
## Image Storage Integration
4
4
@@ -8,13 +8,13 @@ ABC User Feedback supports the integration of image storage solutions to handle
8
8
9
9
There are two methods for uploading images associated with feedback:
10
10
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.
12
12
13
13
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.
14
14
15
15
**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`.
16
16
17
-
### Configuration
17
+
### S3 Configuration
18
18
19
19
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.
### Setup Dev Environment using Command Line Tool without Dependencies
74
95
75
96
ABC User Feedback supports a command line tool(`auf-cli`) that easily runs both the frontend and backend.
76
97
@@ -84,7 +105,7 @@ npx auf-cli stop # stop app
84
105
85
106
Please refer to the following npm package site: https://www.npmjs.com/package/auf-cli
86
107
87
-
## Setup Dev Environment Manually (Local)
108
+
###Setup Dev Environment Manually (Local)
88
109
89
110
ABC User Feedback is using a monorepo (powered by [TurboRepo](https://turbo.build/)) with multiple apps and packages.
90
111
@@ -129,10 +150,6 @@ pnpm turbo run dev --filter=web
129
150
pnpm turbo run dev --filter=api
130
151
```
131
152
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
-
136
153
### Build Docker Image
137
154
138
155
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