Skip to content

Commit

Permalink
chore: update README (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
h4l-yup authored Aug 31, 2023
1 parent 82d5c66 commit e0fef33
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

ABC User Feedback is an open-source platform. It helps to collect and organize user feedback. It consists of a backend built with NestJS and a client built with NextJS.

<p align="center">
<img src="./assets/sample.png">
</p>

# Features

ABC User Feedback provides the following features:
Expand All @@ -24,11 +28,13 @@ Alternatively you can set up a local development environment.
## 1. Official Docker Image Installation

### [web](https://hub.docker.com/r/line/abc-user-feedback-web)

```
docker pull line/abc-user-feedback-web
```

### [api](https://hub.docker.com/r/line/abc-user-feedback-api)

```
docker pull line/abc-user-feedback-api
```
Expand All @@ -39,9 +45,18 @@ docker pull line/abc-user-feedback-api

:bulb: Before you begin, make sure you have the following installed:

#### Required

- [Node.js v16 or above](https://nodejs.org/en/download/)
- [Docker](https://docs.docker.com/desktop/)
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git/)
- [MySQL v8](https://www.mysql.com/downloads/)

#### Optional

- SMTP - for mail verification during making accounts
- [OpenSearch v7](https://opensearch.org/) - for performance on searching feedbacks

You can use [docker-compose.infra.yml](./docker-compose.infra.yml) file for requirements.

### Getting Started With Local Development

Expand Down
Binary file added assets/sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e0fef33

Please sign in to comment.