71 lines
1.9 KiB
Markdown
71 lines
1.9 KiB
Markdown
# ABC User Feedback Frontend
|
|
|
|
ABC User Feedback Frontend is the web browser application that provides the beautiful admin UI. The client is built with NextJS, React Query, React Hook Form, Tailwind css, MUI, and many more.
|
|
|
|
## Setup
|
|
|
|
ABC User Feedback is using a mono-repo with multiple packages. To initialize all the packages on a local development environment, follow the [Getting Started With Local Development](/README.md#getting-started-with-local-development) section to do that in a few quick steps.
|
|
|
|
## Useful Targets
|
|
|
|
You can find a full list of targets in the [package.json](./package.json) file.
|
|
|
|
### `dev`
|
|
|
|
Runs the app in development mode.
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
|
|
|
The page will reload if you make edits.<br />
|
|
You will also see any lint errors in the console.
|
|
|
|
```
|
|
pnpm dev
|
|
```
|
|
|
|
> **Note**
|
|
> In order to run web properly, ui packages need to be built by the
|
|
> `pnpm build:ui` command in root directory or `pnpm turbo run @ufb/ui#build` command in any directory.
|
|
|
|
### `generate-api-type`
|
|
|
|
Generate api type using open api specification. This command can run after running on server. The type file is generated in `src/types/api.type.ts`
|
|
|
|
```
|
|
pnpm generate-api-type
|
|
```
|
|
|
|
### `lint`
|
|
|
|
Performs a linting check using ESLint.
|
|
|
|
```
|
|
pnpm lint
|
|
```
|
|
|
|
### `format`
|
|
|
|
Performs a formatting code using Prettier.
|
|
|
|
```
|
|
pnpm format
|
|
```
|
|
|
|
### `build`
|
|
|
|
Builds the app. The distributable is expored to the `.next` folder.
|
|
|
|
```
|
|
pnpm build
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Environment | Description | Default Value |
|
|
| ------------------------ | ------------------------------------------------------- | --------------------- |
|
|
| NEXT_PUBLIC_API_BASE_URL | api base url in client side (ex. http://localhost:4000) | http://localhost:4000 |
|
|
|
|
## Learn More
|
|
|
|
To learn NextJS, check out the [NextJS documentation](https://nextjs.org/).
|