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: README.md
+69-54Lines changed: 69 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,32 @@
2
2
3
3

4
4
5
-
ABC User Feedback is a standalone web application that manages Voice of Customer (VoC) data. It allows you to gather and sort feedback from your customers. The product is being applied and used in services worth 10 million MAU.
5
+
ABC User Feedback is a standalone web application designed to manage Voice of Customer (VoC) data. It enables you to efficiently gather and categorize customer feedback. The application is currently utilized in services with a reach of 10 million MAU.
6
+
7
+
## Quick Start
8
+
9
+
To quickly set up and run the application locally, follow these steps:
### Setup Dev Environment using Command Line Tool without Dependencies
101
+
### Setup Dev Environment using Command Line Tool
99
102
100
-
ABC User Feedback supports a command line tool(`auf-cli`) that easily runs both the frontend and backend.
103
+
ABC User Feedback supports a command line tool(`auf-cli`) that easily runs both the frontend and backend.
101
104
102
-
With this command line tool, you can initialize the infrastructure and run the app powered by a pre-configured Docker image. Since the CLI is executable with `npx`, only an `npm` environment is required, and no other dependencies are necessary.
105
+
With this tool, you can initialize the infrastructure and run the app using a pre-configured Docker image. Since the CLI is executable with `npx`, only an `npm` environment is required, with no additional dependencies.
103
106
104
107
```bash
105
108
npx auf-cli init # initialize infrastructure
106
109
npx auf-cli start # start app
107
110
npx auf-cli stop # stop app
108
111
```
109
112
110
-
Please refer to the following npm package site: https://www.npmjs.com/package/auf-cli
113
+
Refer to the [npm package site](https://www.npmjs.com/package/auf-cli) for more details.
111
114
112
-
### Setup Dev Environment Manually (Local)
115
+
### Manual Setup (Local)
113
116
114
-
ABC User Feedback is using a monorepo (powered by [TurboRepo](https://turbo.build/)) with multiple apps and packages.
117
+
ABC User Feedback uses a monorepo (powered by [TurboRepo](https://turbo.build/)) with multiple apps and packages.
115
118
116
-
Follow the instructions below to set up a local development environment.
119
+
Follow these instructions to set up a local development environment:
117
120
118
-
1. Clone the repository and install dependencies:
121
+
1.**Clone the Repository and Install Dependencies**:
2. Spin up all required infrastructure (Mysql, OpenSearch, etc.) using Docker Compose:
129
+
2.**Spin Up Required Infrastructure** (MySQL, OpenSearch, etc.) using Docker Compose:
127
130
128
131
```bash
129
132
docker-compose -f docker/docker-compose.infra-amd64.yml up -d
130
133
```
131
134
132
-
3.Make an `.env`file in `apps/api` and `apps/web` by referring to `.env.example` ([web environment variables](./apps/web/README.md), [api environment variables](./apps/api/README.md))
135
+
3.**Create `.env`Files** in `apps/api` and `apps/web` by referring to `.env.example` ([web environment variables](./apps/web/README.md), [api environment variables](./apps/api/README.md)).
133
136
134
-
4. Apply database migrations:
137
+
4.**Apply Database Migrations**:
135
138
136
139
```bash
137
140
cd apps/api
138
141
npm run migration:run
139
142
```
140
143
141
-
5.To start developing, run the `dev` target of both of apps in root directory:
144
+
5.**Start Developing**: Run the `dev` target of both apps in the root directory:
142
145
143
146
```bash
144
147
pnpm dev
145
148
```
146
149
147
-
6. Also, you can run the `dev` target of one of apps in root directory:
148
-
149
-
```bash
150
-
# web
151
-
pnpm dev:web
152
-
153
-
# api
154
-
pnpm dev:api
155
-
```
156
-
157
150
### Build Docker Image
158
151
159
-
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`.
152
+
For your code build, you can build a Docker image using Docker Compose. 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`.
160
153
161
154
```
162
155
docker compose -f docker-compose.yml build
163
156
```
164
157
165
-
Then, run docker-compose
158
+
Then, run Docker Compose:
166
159
167
160
```
168
161
docker compose -f docker-compose.yml up -d
169
162
```
170
163
164
+
## Configuration
165
+
166
+
### Frontend
167
+
168
+
:point_right:[Go to Frontend README](./apps/web/README.md)
169
+
170
+
You can configure the frontend for session password, maximum time span to query, etc.
171
+
172
+
### Backend
173
+
174
+
:point_right:[Go to Backend README](./apps/api/README.md)
175
+
176
+
You can configure the backend for MySQL, SMTP for email verification, OpenSearch-powered improved search experience, etc.
177
+
178
+
## Integration
179
+
180
+
If you want to integrate ABC User Feedback with your service, you can use the following features:
181
+
182
+
1. RESTful Web API - [API document page](https://line.github.io/abc-user-feedback).
183
+
1. Accept images from user - [S3 Integration](./GUIDE.md#image-storage-integration).
0 commit comments