Skip to content

Commit a195291

Browse files
committed
docs: update README for clarity and improved setup instructions
1 parent a6f882b commit a195291

2 files changed

Lines changed: 73 additions & 67 deletions

File tree

README.md

Lines changed: 69 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,32 @@
22

33
![cover image](./assets/cover.png)
44

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:
10+
11+
1. **Clone the Repository**:
12+
13+
```bash
14+
git clone https://github.com/line/abc-user-feedback
15+
cd abc-user-feedback
16+
```
17+
18+
2. **Install Dependencies**:
19+
20+
```bash
21+
pnpm install
22+
```
23+
24+
3. **Start the Application**:
25+
```bash
26+
npx auf-cli init
27+
npx auf-cli start
28+
```
29+
30+
For more detailed setup instructions, refer to the [Getting Started](#getting-started) section.
631

732
<p align="center">
833
<video src="https://github.com/user-attachments/assets/a2ef7a1a-41ec-4cec-b7d1-bda5fbd7d48b" width="100%" />
@@ -34,30 +59,30 @@ ABC User Feedback is a standalone web application that manages Voice of Customer
3459

3560
## Getting Started
3661

37-
The frontend is built with NextJS and the backend is built with NestJS. We provide Docker images for fast and easy setup.
62+
The frontend is built with Next.js and the backend with NestJS. We provide Docker images for a fast and easy setup.
3863

3964
### System Requirements
4065

41-
:bulb: Before you begin, make sure you have the following installed:
66+
Before you begin, ensure you have the following installed:
4267

43-
**Required**
68+
**Required**:
4469

4570
- [Node.js v22 or above](https://nodejs.org/en/download/)
4671
- [Docker](https://docs.docker.com/desktop/)
4772
- [MySQL v8](https://www.mysql.com/downloads/)
4873

49-
**Optional**
74+
**Optional**:
5075

5176
- SMTP - for mail verification during making accounts
5277
- [OpenSearch v2.16](https://opensearch.org/) - for performance on searching feedback
5378

54-
You can use [docker-compose.infra-amd64.yml](/docker/docker-compose.infra-amd64.yml) file for requirements.
79+
You can use the [docker-compose.infra-amd64.yml](/docker/docker-compose.infra-amd64.yml) file for requirements.
5580

56-
for arm architecture, use [docker-compose.infra-arm64.yml](/docker/docker-compose.infra-arm64.yml) file
81+
For ARM architecture, use the [docker-compose.infra-arm64.yml](/docker/docker-compose.infra-arm64.yml) file.
5782

5883
### Docker Hub Images
5984

60-
We publish two images to https://hub.docker.com at every release.
85+
We publish two images to Docker Hub at every release:
6186

6287
#### [Web Admin Frontend](https://hub.docker.com/r/line/abc-user-feedback-web)
6388

@@ -71,103 +96,93 @@ docker pull line/abc-user-feedback-web
7196
docker pull line/abc-user-feedback-api
7297
```
7398

74-
## Configuration
75-
76-
### Frontend
77-
78-
:point_right: [Go to Frontend README](./apps/web/README.md)
79-
80-
You can configure the frontend for session password, maximum time span to query, etc.
81-
82-
### Backend
83-
84-
:point_right: [Go to Backend README](./apps/api/README.md)
85-
86-
You can configure the backend for MySQL, SMTP for email verification, OpenSearch-powered improved search experience, etc.
87-
88-
## Integration
89-
90-
If you want to integrate ABC User Feedback with your service, you can use the following features:
91-
92-
1. RESTful Web API - [API document page](https://line.github.io/abc-user-feedback).
93-
1. Accept images from user - [S3 Integration](./GUIDE.md#image-storage-integration).
94-
1. Webhooks - [Webhook specification](./GUIDE.md#Webhook-Feature).
95-
9699
## Development
97100

98-
### Setup Dev Environment using Command Line Tool without Dependencies
101+
### Setup Dev Environment using Command Line Tool
99102

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.
101104

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.
103106

104107
```bash
105108
npx auf-cli init # initialize infrastructure
106109
npx auf-cli start # start app
107110
npx auf-cli stop # stop app
108111
```
109112

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.
111114

112-
### Setup Dev Environment Manually (Local)
115+
### Manual Setup (Local)
113116

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.
115118

116-
Follow the instructions below to set up a local development environment.
119+
Follow these instructions to set up a local development environment:
117120

118-
1. Clone the repository and install dependencies:
121+
1. **Clone the Repository and Install Dependencies**:
119122

120123
```bash
121124
git clone https://github.com/line/abc-user-feedback
122125
cd abc-user-feedback
123126
pnpm install
124127
```
125128

126-
2. Spin up all required infrastructure (Mysql, OpenSearch, etc.) using Docker Compose:
129+
2. **Spin Up Required Infrastructure** (MySQL, OpenSearch, etc.) using Docker Compose:
127130

128131
```bash
129132
docker-compose -f docker/docker-compose.infra-amd64.yml up -d
130133
```
131134

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)).
133136

134-
4. Apply database migrations:
137+
4. **Apply Database Migrations**:
135138

136139
```bash
137140
cd apps/api
138141
npm run migration:run
139142
```
140143

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:
142145

143146
```bash
144147
pnpm dev
145148
```
146149

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-
157150
### Build Docker Image
158151

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`.
160153

161154
```
162155
docker compose -f docker-compose.yml build
163156
```
164157

165-
Then, run docker-compose
158+
Then, run Docker Compose:
166159

167160
```
168161
docker compose -f docker-compose.yml up -d
169162
```
170163

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).
184+
1. Webhooks - [Webhook specification](./GUIDE.md#Webhook-Feature).
185+
171186
## Contributing Guidelines
172187

173188
Please follow the [contributing guidelines](./CONTRIBUTING.md) to contribute to the project.

apps/api/src/configs/modules/mailer-config/mailer-config.module.ts

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,28 +25,19 @@ import type { ConfigServiceType } from '@/types/config-service.type';
2525
MailerModule.forRootAsync({
2626
inject: [ConfigService],
2727
useFactory: (configService: ConfigService<ConfigServiceType>) => {
28-
const {
29-
host,
30-
password,
31-
port,
32-
username,
33-
sender,
34-
tls,
35-
cipherSpec,
36-
opportunisticTLS,
37-
} = configService.get('smtp', { infer: true }) ?? {};
28+
const { host, password, port, username, sender } =
29+
configService.get('smtp', { infer: true }) ?? {};
3830
return {
3931
transport: {
4032
host,
4133
port,
42-
tls: { ciphers: cipherSpec },
34+
tls: { ciphers: 'SSLv3' },
4335
auth:
4436
username && password ?
4537
{ user: username, pass: password }
4638
: undefined,
47-
secure: tls,
39+
secure: port === 465,
4840
pool: true,
49-
opportunisticTLS,
5041
},
5142
defaults: { from: `"User feedback" <${sender}>` },
5243
template: {

0 commit comments

Comments
 (0)