ABC User Feedback Backend provides API and its related operations. It is built with Node.js, NestJS, Typeorm, and many more.
ABC User Feedback is using a mono-repo with multiple packages.
You can find a full list of targets in the package.json file.
Runs the app in development mode.
pnpm dev
Executes tests. This command applies to the environment variables in .env.test file.
pnpm test
Executes e2e tests. This command applies to the environment variables in .env.test file.
pnpm test:e2e
Performs a linting check using ESLint.
pnpm lint
Builds the app for production. The distributable is expored to the dist folder in the repository's root folder.
pnpm build
Generate the migration file using typeorm. The file is generated in src/configs/modules/typeorm-config/migrations
npm run migration:generate --name={NAME}
Run the migration files for database migrations
npm run migration:run
The following is a list of environment variables used by the application, along with their descriptions and default values.
| Environment | Description | Default Value |
|---|---|---|
JWT_SECRET |
Secret key for signing JSON Web Tokens (JWT) | required |
MYSQL_PRIMARY_URL |
Primary MySQL connection URL | mysql://userfeedback:userfeedback@localhost:13306/test |
BASE_URL |
Base URL of the application | http://localhost:3000 |
ACCESS_TOKEN_EXPIRED_TIME |
Duration until the access token expires | 10m |
REFESH_TOKEN_EXPIRED_TIME |
Duration until the refresh token expires | 1h |
| Environment | Description | Default Value |
|---|---|---|
APP_PORT |
The port that the server runs on | 4000 |
APP_ADDRESS |
The address that the server binds to | 0.0.0.0 |
MYSQL_SECONDARY_URLS |
Secondary MySQL connection URLs (must be in JSON array format) | optional |
SMTP_USE |
Flag to enable SMTP server usage (for email verification) | false |
SMTP_HOST |
SMTP server host | required if SMTP_USE=true |
SMTP_PORT |
SMTP server port | required if SMTP_USE=true |
SMTP_USERNAME |
SMTP server authentication username | optional |
SMTP_PASSWORD |
SMTP server authentication password | optional |
SMTP_SENDER |
Email address used as sender in emails | required if SMTP_USE=true |
SMTP_BASE_URL |
Base URL for emails to link back to the application | required if SMTP_USE=true |
OPENSEARCH_USE |
Flag to enable OpenSearch integration | false |
OPENSEARCH_NODE |
OpenSearch node URL | required if OPENSEARCH_USE=true |
OPENSEARCH_USERNAME |
OpenSearch username (if authentication is enabled) | required if OPENSEARCH_USE=true |
OPENSEARCH_PASSWORD |
OpenSearch password (if authentication is enabled) | required if OPENSEARCH_USE=true |
AUTO_MIGRATION |
Automatically perform database migration on application start | true |
MASTER_API_KEY |
Master API key for privileged operations | none |
ENABLE_AUTO_FEEDBACK_DELETION |
Enable auto old feedback deletion cron on application start | false |
AUTO_FEEDBACK_DELETION_PERIOD_DAYS |
Auto old feedback deletion period (in days) | required if ENABLE_AUTO_FEEDBACK_DELETION |
Please ensure that you set the required environment variables before starting the application. Optional variables can be set as needed based on your specific configuration and requirements.
The swagger documentation can be found on the /docs endpoint.
Dashboard data is generated by mysql data every AM 00:00 with the timezone set by its project with schedulers.
The schedulers generate data for 365 days.
If you want to generate dashboard data by yourself, you can use /migration/statistics APIs (ref: migration API)
With the APIs you can generate data which are inserted more than 365 days.
If you are willing to change the project's timezone, you can manually change it in mysql database. (it is not available in admin web as it is not a usual case.) Then you should delete all statistics data and re-genearte by migration APIs.
To learn NestJS, check out the NestJS documentation.