VPO Help

This project was generated using Nx.
Server is a monolith built using NestJS framework.
Client is a React application.

Deploy

Using Docker

Copy ./apps/api/.env.dev and rename to .env. Change environment variables to production ones.
Run the following command:
docker compose -f compose.prod.yaml up --build

Manually

Install dependencies
1.1 Git
1.2 Node.js 16+
1.3 MongoDB
Install npm dependencies (in project's folder):
npm i
Build (in project's folder):
npm run build
Create .env file in project's root (see ./apps/api/.env.dev) OR provide environment variables to the run command (see the next step).
Run API server (in project's folder):
npm start

Test

Run automated tests:

npm run test

API

This project has monolithic architecture and provides the following REST-full API (some endpoints might not be reflected in this doc):

POST /auth/login

// PAYLOAD
LoginAsUserDto {
  email: String,
  password: String
}
// RESPONSE
LoginAsUserResponse {
  user: UserModel {
    id: String,
    role: "ADMIN",
    email: String,
  },
  permissions: PermissionMap,
  accessToken: { access_token: String }
}

POST /auth/login/vpo

// PAYLOAD
LoginAsVpoDto {
  vpoReferenceNumber: String,
}
// RESPONSE
LoginAsVpoResponseDto {
  user: VpoUserModel {
    id: String,
    role: "VPO",
    vpoReferenceNumber: String,
    scheduleDate: DateISOString,
  },
  permissions: PermissionMap,
  accessToken: { access_token: String },
}

POST /send-vpo-verification

// PAYLOAD
EmailHolderDto {
  email: String,
}
// RESPONSE
200

PUT /schedule

Auth, Permissions: ["SCHEDULE.WRITE"]

// PAYLOAD
ScheduleDto {
  0: [
    {
      timeFrom: TimeString,
      timeTo: TimeString,
      numberOfPersons: Number,
    }
  ],
  ...,
  6: [{...}],
}
// RESPONSE
{ ...ScheduleDto }

GET /schedule

// RESPONSE
{ ...ScheduleDto }

GET /schedule/available

// RESPONSE
ScheduleAvailableDto {
  items: [
    ScheduleSlotAvailableDto {
      dateFrom: DateISOString,
      dateTo: DateISOString,
    },
  ];
}

POST /vpo

// PAYLOAD
RegisterVpoDto {
  email: String,
  verificationCode: String,
  vpoIssueDate: DateISOString,
  vpoReferenceNumber: String,
  firstName: String,
  lastName: String,
  middleName: String,
  phoneNumber: String,
  dateOfBirth: DateISOString,
  addressOfRegistration: String,
  addressOfResidence: String,
  numberOfRelatives: Number,
  numberOfRelativesBelow16: Number,
  numberOfRelativesAbove65: Number,
  scheduleDate: DateISOString,
  receivedHelpDate?: DateISOString,
  receivedGoods?: { [productName]: Number },
}
// RESPONSE
{ ...VpoUserModel }

GET /vpo?PaginationSearchSort

Auth, Permissions: ["VPO_LIST.READ"]

// RESPONSE
{
  items: [VpoModel],
  totalItems: Number,
}

GET /vpo/export?PaginationSearchSort

Auth, Permissions: ["VPO_EXPORT.READ"]

// RESPONSE
vpo_table.csv;

POST /vpo/import

Auth, Permissions: ["VPO_IMPORT.WRITE"]

// PAYLOAD
vpo_that_received_goods_table.csv;

// RESPONSE
200;

PUT /settings

Auth, Permissions: ["SETTINGS.WRITE"]

// PAYLOAD
UpdateSettingsDto {
  daysToNextVpoRegistration?: Number,
  endOfRegistrationDate?: DateISOString,
  scheduleDaysAvailable?: Number,
}
// RESPONSE
{ ...SettingsDto }

GET /settings

Auth, Permissions: ["SETTINGS.READ"]

// RESPONSE
{ ...SettingsDto }

GET /html/:pageName

// RESPONSE
HtmlPageModel {
  id: String,
  name: String,
  content: {
    [fieldName]: String,
  }
}

PUT /html/:pageName

Auth, Permissions: ["HTML.WRITE"]

// PAYLOAD
{
  name?: String,
  content: {
    [fieldName]: String,
  }
}
// RESPONSE
{ ...HtmlPageModel }

vpo-help

Commits

feat: show relatives fields based on env

feat: admin can mark registration period as the last one

fix: show correct message when vpo schedules 2nd time after receiving help

feat: return to slot selection step if slot is not available (#2)

fix: date rerender on info screen

feat: showing vpo reference numbers on success registration screen (#1)

README