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.
ABC User Feedback provides the following features:
- Dynamic Feedback Field
- Feedback Tagging
- Addon Issue tracking
- Role Based Access Control (RBAC)
- Admin UI
You can get started with Docker image on your server.
Alternatively you can set up a local development environment.
docker pull line/abc-user-feedback-web
docker pull line/abc-user-feedback-api
๐ก Before you begin, make sure you have the following installed:
- SMTP - for mail verification during making accounts
- OpenSearch v7 - for performance on searching feedbacks
You can use docker-compose.infra.yml file for requirements.
ABC User Feedback is using a monorepo (powered by TurboRepo) with multiple apps and packages.
Follow these simple instructions to set up a local development environment.
- Clone the repository and install dependencies:
git clone https://github.com/line/abc-user-feedback
cd abc-user-feedback
yarn install
- Spin up all required infrastructure (Mysql, Opensearch, etc.) using Docker Compose:
docker-compose -f docker-compose.infra.yml up -d
-
Make an
.env
file inapps/api
andapps/web
by referring to.env.example
(web environment variables, api environment variables) -
Apply database migrations:
cd apps/api
npm run migration:run
- To start developing, run the
dev
target of both of apps in root directory:
yarn dev
You can always find more information in each app/library's respective README.md file.
You can use a manual step-by-step approach to set up ABC User Feedback in a local development environment. To do so, you should follow the following instructions for Setting Up ABC User Feedback Server, and Setting Up ABC User Feedback Client.
Setting up ABC User Feedback Server
ABC User Feedback Server is built with the following awesome open-source technologies: Node.js, NestJS, Typeorm, and many more.
Setting Up ABC User Feedback Client
ABC User Feedback Client is the front end of the platform that provides you with an easy-to-drive UI for building your next low-code application. The client is based on React, React Hook Form, React Query, Tailwind css, MUI, and more.
For your code build, you can buile docker image using docker-compose
docker-compose build
Then, run docker-compose
docker-compose up -d
Please follow the contributing guidelines to contribute to the project.
Copyright 2023 LINE Corporation
LINE Corporation licenses this file to you under the Apache License,
version 2.0 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at:
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
See LICENSE for more details.